Merge pull request #532 from neurodata/staging

ENH add new experiment notebooks & DOC update documentation for algorithm names
neurodata · Jan 17, 2022 · 56fe623 · 56fe623
2 parents 31b0f3d + f2afc14
commit 56fe623
Show file tree

Hide file tree

Showing 40 changed files with 4,801 additions and 212 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -13,7 +13,7 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          key: v1-<< parameters.version >>-min-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-<< parameters.version >>-min-dependency-cache-{{ checksum "dev-requirements.txt" }}
       - run:
           name: install python dependencies
           command: |
@@ -22,7 +22,7 @@ jobs:
             pip install --upgrade pip
             pip install -r dev-requirements.txt
       - save_cache:
-          key: v1-<< parameters.version >>-min-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-<< parameters.version >>-min-dependency-cache-{{ checksum "dev-requirements.txt" }}
           paths:
             - "venv"
       - run:
@@ -41,11 +41,11 @@ jobs:
       tutorials:
         type: string
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.9
     steps:
       - checkout
       - restore_cache:
-          key: v1-3.8-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-3.9-dependency-cache-{{ checksum "dev-requirements.txt" }}
       - run:
           name: install python dependencies
           command: |
@@ -54,7 +54,7 @@ jobs:
             pip install -r dev-requirements.txt
             pip install -e .
       - save_cache:
-          key: v1-3.8-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-3.9-dependency-cache-{{ checksum "dev-requirements.txt" }}
           paths:
             - "venv"
       - run:
@@ -78,11 +78,11 @@ jobs:
           file: "coverage.xml"
   deploy:
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.9
     steps:
       - checkout
       - restore_cache:
-          key: v1-3.8-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-3.9-dependency-cache-{{ checksum "dev-requirements.txt" }}
       - run:
           name: install python dependencies
           command: |
@@ -91,7 +91,7 @@ jobs:
             pip install -r dev-requirements.txt
             pip install -e .
       - save_cache:
-          key: v1-3.8-dependency-cache-{{ checksum "dev-requirements.txt" }}
+          key: v2-3.9-dependency-cache-{{ checksum "dev-requirements.txt" }}
           paths:
             - "venv"
       - run:
@@ -127,14 +127,17 @@ workflows:
       - build:
           name: "v3.8"
           version: "3.8"
+      - build:
+          name: "v3.9"
+          version: "3.9"
       - test-module:
           name: "proglearn"
           module: "proglearn"
           benchmarks: "benchmarks/"
           experiments: "docs/experiments/"
           tutorials: "docs/tutorials/"
           requires:
-            - "v3.8"
+            - "v3.9"
       - deploy:
           filters:
             tags:

diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+docs/** -linguist-documentation
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,3 +1,4 @@
+wheel
 -r requirements.txt
 pytest
 coverage

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -191,11 +191,16 @@ Properly formatted Jupyter notebooks are required for Netlify deployment.
 It is recommended to check that your tutorial completes the following
 steps before submitting:
 
+- ``black`` format your notebook. Use the official 
+  ``black[jupyter]`` `package <https://github.com/psf/black>`_.
+
 - Add your notebook name to `docs/tutorials.rst
-  </docs/tutorials.rst>`_ if applicable.
+  </docs/tutorials.rst>`_ or `docs/experiments.rst
+  </docs/experiments.rst>`_ if applicable.
 
 - Organize local functions into a separate file and put it in
-  `docs/tutorials/functions </docs/tutorials/functions>`_.
+  `docs/tutorials/functions </docs/tutorials/functions>`_ or 
+  `docs/experiments/functions </docs/experiments/functions>`_.
   This function file and the notebook should have the same name.
 
 - Make your tutorial self-contained if possible. It should neither

diff --git a/docs/experiments.rst b/docs/experiments.rst
@@ -19,5 +19,6 @@ The following experiments illustrate specific tests using the ``ProgLearn`` pack
     experiments/xor_rxor_exp
     experiments/xor_rxor_with_cpd
     experiments/xor_rxor_with_icp
+    experiments/xor_rxor_with_unaware
     experiments/xor_xnor_exp
     experiments/double_descent_RF