Documentation

[philipparubin]

Sphinx Documentation

Pages added (from home page)

1. "Getting started"
   • "RoughPy: the absolute basics for beginners". Anagrams example.
2. "User guide"
   • "Getting started"
     • "What is RoughPy?". Short introduction. Signatures of Streams clip. References.
     • "Installation". Basic installation with pip. Links to wheels, and building from source.
     • "RoughPy: the absolute basics for beginners". Anagrams example.
   • "Fundamentals and usage"
     • "RoughPy Fundamentals". All the following pages are of the form: What are X? How do X fit into RoughPy? How to work with X, with example constructors and functions. Literature references using X.
       • "Contexts".
       • "Streams"
       • "Intervals"
       • "Free Tensors"
       • "Shuffle Tensors"
       • "Lies"
     • "RoughPy Tutorials". Notebooks generated from here.
       • "Logsignature example"
       • "Controlled Neural Differential Equations - Time Series Classification"
       • "Path Signatures for Drone Classification using esig"
       • "Path Signautre Methodology for Landmark-based Human Action Recognition"
       • "Path Signatures for Handwritten Digit Classification Using Esig"
       • "Path Signatures for Natural Language Processing"
       • "Path Signatures for Early Sepsis Detection"
   • "Advanced usage"
     • "Building from source". Installation with vcpkg.
     • "Literature references". A list of references for using signature methods. Different to the literature references in bibiography, on each of the fundamentals pages.
3. "API reference"
   • Autogenerated API reference using autodoc
4. "Contributor's guide"
   • Note on contributing to RoughPy. Current status, "In the future, we will welcome pull requests to implement new features, fix bugs, add documentation or examples, or add tests to the project. However, at present, we do not have robust CI pipelines set up to rigorously test incoming changes, and therefore will not be accepting pull requests made from outside the current team."

Also has "Release notes", "Source Repository" and "Issue Tracker" from home page.

Notes

• You have to use CMake to build the "Sphinx" target, introduced when tidying the notebooks
• Videos and other files are stored using git-lfs