Skip to content

Tutorials documentation is unfinished #21

Description

@kslote1

The paper states "Extensive tutorials and example notebooks are provided in the public documentation." The live page at https://causationentropy.readthedocs.io/en/latest/tutorials/index.html contains, verbatim, an unedited authoring instruction:

Create examples/basic_usage.rst:

followed by a snippet using pd without importing pandas, and a .. figure:: directive pointing at _static/images/diagrams/basic_flow.png, which does not exist in the repo. The notebooks/* glob in tutorials/index.rst matches nothing, so none of the seven notebooks are rendered in the documentation at all — they exist only in the repo. The API reference and the theory guide are genuinely good; the tutorial section is the weakest and most user-facing part.

Separately, notebooks/geometric_knn_causal_discovery_example.ipynb is committed with a stored ModuleNotFoundError: No module named 'causationentropy' output — it was never successfully executed. Notebooks are not executed in CI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions