Torch instances (#25)

* Change doc theme

* Add numpy/pytorch instance types and change to index based classification

* Rebuild notebooks

* Fix dataset downloads

* Update doctests

.github/workflows/unit_test.yml

@@ -33,6 +33,12 @@ jobs:
       run: |
         python -m pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
         python -m pip install ".[dev]"
+    - name: Cache Test Datasets
+      id: cache-test-datasets
+      uses: actions/cache@v4
+      with:
+        path: data
+        key: "test-datasets"
     - name: PyTest
       run: invoke test.unit
     - name: Notebooks

docs/api.rst

@@ -1,4 +1,5 @@
 .. _api:
+
 API
 ===
 
@@ -27,16 +28,37 @@ Instances are the basic unit of data in CapyMOA.
     :inherited-members:
     :show-inheritance:
 
+.. autoclass:: capymoa.stream.instance.NpInstance
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
+.. autoclass:: capymoa.stream.instance.NpLabeledInstance
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
+.. autoclass:: capymoa.stream.instance.NpRegressionInstance
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
 Stream
 ------
 A datastream is a sequence of instances arriving one at a time.
 
 
-.. automodule:: capymoa.stream
+.. automodule:: capymoa.stream.stream
     :members:
     :undoc-members:
+    :show-inheritance:
     :inherited-members:
 
+.. autoclass:: capymoa.stream.PytorchStream.PytorchStream
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
 
 
 Learners

docs/conf.py

@@ -24,6 +24,8 @@
     "sphinx.ext.doctest",
 ]
 
+autoclass_content = 'both'
+
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
@@ -36,7 +38,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
 html_static_path = ['_static']
 
 # Setup symbolic links for notebooks

docs/contributing.rst

@@ -37,15 +37,12 @@ are written in the form of examples in a python interactive shell.
 
 Use this type of test for simple examples and as a way to document the code.
 
-CapyMOA uses the `sphinx.ext.doctest <https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html#module-sphinx.ext.doctest>`_
-to add these tests in the documentation. Here is an example of a doctest::
-
-    """
-    ..  doctest:: python
-
-        >>> print("Hello, World!")
+    def hello_world():
+        """
+        >>> hello_world()
         Hello, World!
-    """
+        """
+        print("Hello, World!")
 
 They can be run with the following command::
 

docs/installation.rst

@@ -45,7 +45,7 @@ get the correct version for your hardware.
 
 Install CapyMOA
 ---------------
-Within the activated environment, you can install CapyMOA with pip:
+To install CapyMOA, you can use pip:
 
 .. code-block:: sh
 

invoke.yml

@@ -5,4 +5,4 @@ moa_url: "https://homepages.ecs.vuw.ac.nz/~antonlee/capymoa/moa.jar"
 
 # What notebooks to skip when running them as tests.
 test_skip_notebooks:
-  - notebooks/Using_jpype_MOA_example.ipynb
+  # - my_notebook.ipynb