In progress commit on branch dev.

Author: patrick-kidger

.github/workflows/build.yml

@@ -11,15 +11,14 @@ name: Build and test
 # Arguments:
 # event_name: pull_request
 # event_cond: true
-# trigger: -not-available-  # not available via repository_dispatch (there's no pull request to test!)
+# trigger: -not-available-  # not available via repository_dispatch (we'd need a way to specify which pull request we want tested; not obvious if that's possible)
 
 
 on:
   repository_dispatch:
   pull_request:
     branches:
       - master
-    
 
 jobs:
   check_version:
@@ -86,7 +85,7 @@ jobs:
       if: ((github.event_name == 'pull_request' && (true)) || (github.event_name == 'repository_dispatch' && contains(github.event.action, '-trigger -not-available- ') && ((contains(github.event.action, '-os windows-2016') && matrix.os == 'windows-2016') || (contains(github.event.action, '-os ubuntu-16.04') && matrix.os == 'ubuntu-16.04') || (contains(github.event.action, '-os macOS-10.14') && matrix.os == 'macOS-10.14') || contains(github.event.action, '-os *')) && ((contains(github.event.action, '-pv 2.7.13') && matrix.python-version == '2.7.13') || (contains(github.event.action, '-pv 3.5.4') && matrix.python-version == '3.5.4') || (contains(github.event.action, '-pv 3.6.2') && matrix.python-version == '3.6.2') || (contains(github.event.action, '-pv 3.7.0') && matrix.python-version == '3.7.0') || contains(github.event.action, '-pv *'))))
       run: |
         cp README.rst README.rst.old
-        python command.py genreadme
+        python command.py readme
         python -c "import io
         import sys
         readme = io.open('README.rst', 'r', encoding='utf-8')

.github/workflows/deploy.yml

@@ -28,7 +28,7 @@ jobs:
       matrix:
         os: [ubuntu-16.04]
         python-version: [3.7.0]
-        pytorch-version: [1.2.0]
+        pytorch-version: [1.2.0, 1.3.0]
 
     steps:
     - name: Checkout code
@@ -59,11 +59,6 @@ jobs:
         python setup.py egg_info --tag-build="-torch${{ matrix.pytorch-version }}" sdist
         pip install twine
         twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-        cd installer
-        python -c "import command; command.set_up()"
-        python setup.py sdist
-        twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-        cd ..
       
  
   deploy:
@@ -110,18 +105,13 @@ jobs:
         python setup.py egg_info --tag-build="-torch${{ matrix.pytorch-version }}" bdist_wheel &&
         pip install twine &&
         twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/* &&
-        cd installer &&
-        python -c "import command.py; command.set_up()" &&
-        python setup.py sdist &&
-        twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/* &&
-        cd .. &&
         python -c "import subprocess;
         import sys;
         import time;
         import metadata;
         sleep = lambda t: time.sleep(t) or True;
         retry = lambda fn: fn() or (sleep(20) and fn()) or (sleep(40) and fn()) or (sleep(120) and fn()) or (sleep(240) and fn());
-        ret = retry(lambda: not subprocess.run('python -m pip install signatory_installer=={}'.format(metadata.version)).returncode);
+        ret = retry(lambda: not subprocess.run('python -m pip install signatory==' + metadata.version + '-torch${{ matrix.pytorch-version }}').returncode);
         sys.exit(not ret)
         " &&
         python -m pip install iisignature &&
@@ -150,7 +140,7 @@ jobs:
         python command.py should_not_import
         retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
         SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-        retry python -m pip install signatory_installer==$SIGNATORY_VERSION
+        retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}
         python -m pip install iisignature
         python -c "import os
         import subprocess
@@ -178,14 +168,9 @@ jobs:
         MACOSX_DEPLOYMENT_TARGET=10.9 CC=clang CXX=clang++ python setup.py egg_info --tag-build="-torch${{ matrix.pytorch-version }}" bdist_wheel
         pip install twine
         twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-        cd installer
-        python -c "import command; command.set_up()"
-        python setup.py sdist
-        twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-        cd ..
         retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
         SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-        retry python -m pip install signatory_installer==$SIGNATORY_VERSION
+        retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}
         git clone https://github.com/bottler/iisignature.git
         cd iisignature
         python setup.py install

.github/workflows/test_deployed.yml

@@ -62,7 +62,7 @@ jobs:
         import metadata;
         sleep = lambda t: time.sleep(t) or True;
         retry = lambda fn: fn() or (sleep(20) and fn()) or (sleep(40) and fn()) or (sleep(120) and fn()) or (sleep(240) and fn());
-        ret = retry(lambda: not subprocess.run('python -m pip install signatory_installer=={}'.format(metadata.version)).returncode);
+        ret = retry(lambda: not subprocess.run('python -m pip install signatory==' + metadata.version + '-torch${{ matrix.pytorch-version }}').returncode);
         sys.exit(not ret)
         " &&
         python -m pip install iisignature &&
@@ -91,7 +91,7 @@ jobs:
         python command.py should_not_import
         retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
         SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-        retry python -m pip install signatory_installer==$SIGNATORY_VERSION
+        retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}
         python -m pip install iisignature
         python -c "import os
         import subprocess
@@ -118,7 +118,7 @@ jobs:
         python command.py should_not_import
         retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
         SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-        retry python -m pip install signatory_installer==$SIGNATORY_VERSION
+        retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}
         git clone https://github.com/bottler/iisignature.git
         cd iisignature
         python setup.py install

.github/workflows_templates/build.yml.template

@@ -5,13 +5,12 @@ name: Build and test
 # Arguments:
 # event_name: pull_request
 # event_cond: true
-# trigger: -not-available-  # not available via repository_dispatch (there's no pull request to test!)
+# trigger: -not-available-  # not available via repository_dispatch (we'd need a way to specify which pull request we want tested; not obvious if that's possible)
 
 
 <<on>>
     branches:
       - master
-    
 
 jobs:
   check_version:
@@ -54,7 +53,7 @@ jobs:
       <<if_>>
       run: |
         cp README.rst README.rst.old
-        python command.py genreadme
+        python command.py readme
         python -c "import io
         import sys
         readme = io.open('README.rst', 'r', encoding='utf-8')

.github/workflows_templates/deploy.yml.template

@@ -15,7 +15,7 @@ name: Deploy and test
 jobs:
   # we need to do this first as all the linux versions install the same thing from PyPI
   deploy_sdist:
-    <<strategy_single>>
+    <<strategy_single_all_pytorch>>
     steps:
     - <<checkout_code>>
       with:

.github/workflows_templates/from_template.py

@@ -128,8 +128,17 @@ def _substitute(filename, **subs):
 linux = "ubuntu-16.04",
 mac = "macOS-10.14",
 
+# Run on repository_dispatch and precisely one other event
+on = \
+"""on:
+  repository_dispatch:
+  <<event_name>>:""",
+
+# Only run on repository_dispatch
+on_rd = "on: repository_dispatch",
+
 # Versions of Python
-# Note that it's actually important to specify the patch number here as well for maximum compatability.
+# Note that it's actually important to specify the patch number here as well for maximum compatibility.
 # (e.g. 3.6.6 vs 3.6.9 does break things)
 py27 = '2.7.13',
 py35 = '3.5.4',
@@ -139,15 +148,7 @@ def _substitute(filename, **subs):
 # Versions of PyTorch
 pytorch12 = '1.2.0',
 pytorch13 = '1.3.0',
-
-# Run on repository_dispatch and precisely one other event
-on = \
-"""on:
-  repository_dispatch:
-  <<event_name>>:""",
-
-# Only run on repository_dispatch
-on_rd = "on: repository_dispatch",
+pytorch_all = '[<<pytorch12>>, <<pytorch13>>]',
 
 # A strategy for every operating system and version of Python
 # Note that every possible combination must be specified in action_os and action_pv to have repository_dispatch work
@@ -158,7 +159,7 @@ def _substitute(filename, **subs):
   matrix:
     os: [<<windows>>, <<linux>>, <<mac>>]
     python-version: [<<py27>>, <<py35>>, <<py36>>, <<py37>>]
-    pytorch-version: [<<pytorch12>>, <<pytorch13>>]
+    pytorch-version: <<pytorch_all>>
     exclude:
       # PyTorch doesn't support this combination
       - os: <<windows>>
@@ -175,6 +176,16 @@ def _substitute(filename, **subs):
     pytorch-version: [<<pytorch12>>]
 """,
 
+# A single Linux strategy except with all PyTorch versions
+strategy_single_all_pytorch = \
+"""runs-on: ${{ matrix.os }}
+strategy:
+  matrix:
+    os: [<<linux>>]
+    python-version: [<<py37>>]
+    pytorch-version: <<pytorch_all>>
+""",
+
 # Tests whether a repository_dispatch-triggered action is triggered at all
 # Note that trigger is intended to have a space after it (used to distinguish similar triggers)
 action_trigger = "contains(github.event.action, '-trigger <<trigger>> ')",
@@ -186,7 +197,7 @@ def _substitute(filename, **subs):
 _action_os_linux = "(contains(github.event.action, '-os <<linux>>') && matrix.os == '<<linux>>')",
 _action_os_mac = "(contains(github.event.action, '-os <<mac>>') && matrix.os == '<<mac>>')",
 _action_os_star = "contains(github.event.action, '-os *')",
-action_os = "(<<_action_os_windows>> || <<_action_os_linux>> || <<_action_os_mac>> || <<_action_os_star>>)", 
+action_os = "(<<_action_os_windows>> || <<_action_os_linux>> || <<_action_os_mac>> || <<_action_os_star>>)",
 
 # Tests whether a repository_dispatch-triggered action is triggered, depending on Python version
 _action_pv_27 = "(contains(github.event.action, '-pv <<py27>>') && matrix.python-version == '<<py27>>')",
@@ -242,7 +253,7 @@ def _substitute(filename, **subs):
   python -m pip install --upgrade pip &&
   conda install pytorch==${{ matrix.pytorch-version }} -c pytorch -y &&
   python command.py should_not_import &&""",
-  
+
 # Builds a bdist_wheel on Windows
 build_windows = '  python setup.py egg_info --tag-build="-torch${{ matrix.pytorch-version }}" bdist_wheel &&',
 
@@ -257,7 +268,7 @@ def _substitute(filename, **subs):
   import metadata;
   sleep = lambda t: time.sleep(t) or True;
   retry = lambda fn: fn() or (sleep(20) and fn()) or (sleep(40) and fn()) or (sleep(120) and fn()) or (sleep(240) and fn());
-  ret = retry(lambda: not subprocess.run('python -m pip install signatory_installer=={}'.format(metadata.version)).returncode);
+  ret = retry(lambda: not subprocess.run('python -m pip install signatory==' + metadata.version + '-torch${{ matrix.pytorch-version }}').returncode);
   sys.exit(not ret)
   " &&""",
 
@@ -308,7 +319,7 @@ def _substitute(filename, **subs):
 install_remote_linux = \
 """  retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
   SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-  retry python -m pip install signatory_installer==$SIGNATORY_VERSION""",
+  retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}""",
 
 # Runs tests on Linux
 test_linux = \
@@ -358,7 +369,7 @@ def _substitute(filename, **subs):
 install_remote_mac = \
 """  retry () { $* || (sleep 20 && $*) || (sleep 40 && $*) || (sleep 120 && $*) || (sleep 240 && $*); }
   SIGNATORY_VERSION=$(python -c "import metadata; print(metadata.version)")
-  retry python -m pip install signatory_installer==$SIGNATORY_VERSION""",
+  retry python -m pip install signatory==$SIGNATORY_VERSION-torch${{ matrix.pytorch-version }}""",
 
 # Runs tests on Mac
 test_mac = \
@@ -382,25 +393,15 @@ def _substitute(filename, **subs):
   chmod +x $GITHUB_WORKSPACE/to_run.sh
   sudo -s -H -E $GITHUB_WORKSPACE/to_run.sh""",
 
-# Uploads dist/* to PyPI for Windows, and uploads the installer script
+# Uploads dist/* to PyPI for Windows
 upload_windows = \
 r"""  pip install twine &&
-  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/* &&
-  cd installer &&
-  python command.py setup &&
-  python setup.py sdist &&
-  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/* &&
-  cd .. &&""",
-
-# Uploads dist/* to PyPI for Unix, and uploads the installer script
+  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/* &&""",
+
+# Uploads dist/* to PyPI for Unix
 upload_unix = \
 """  pip install twine
-  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-  cd installer
-  python command.py setup
-  python setup.py sdist
-  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*
-  cd ..""",
+  twine upload -u patrick-kidger -p ${{ secrets.pypi_password }} dist/*""",
 )  # end of global_subs
 global_subs['upload_mac'] = global_subs['upload_linux'] = global_subs['upload_unix']
 

MANIFEST.in

@@ -4,5 +4,4 @@ include LICENSE
 include metadata.py
 recursive-include src *.hpp
 recursive-include src *.inl
-prune test
-prune installer
+prune test

README.rst

@@ -23,10 +23,13 @@ Available for Python 2.7, Python 3.5, Python 3.6, Python 3.7 and Linux, Mac, Win
 
 Requires `PyTorch <http://pytorch.org/>`__.
 
-Install via ``pip install signatory_installer``. Then just ``import signatory`` inside Python.
+Install via ``pip install signatory==<SIGNATORY_VERSION>-torch<TORCH_VERSION>``, where ``<SIGNATORY_VERSION>`` is the version of Signatory you would like to download (the most recent version is 1.1.4) and ``<TORCH_VERSION>`` is the version of PyTorch you are using (supported versions are PyTorch 1.2.0 and 1.3.0). Then just ``import signatory`` inside Python.
 
 
-    The ``installer`` is because this command actually downloads a script which detects the version of PyTorch that is currently installed, and then downloads the corresponding version of Signatory. If you already know that you are using e.g. PyTorch 1.2.0 and want Signatory 1.1.4, then you can just run ``pip install signatory==1.1.4-torch1.2.0``.
+    For example, if you are using PyTorch 1.2.0 and want Signatory 1.1.4, then you should run ``pip install signatory==1.1.4-torch1.2.0``.
+
+
+    Take care **not** to run ``pip install signatory``, as this will likely download the wrong version. This care is needed due to a `limitation of PyTorch <https://github.com/pytorch/pytorch/issues/28754>`__.
 
 Installation from source is also possible; please consult the `documentation <https://signatory.readthedocs.io/en/latest/pages/usage/installation.html#usage-install-from-source>`__. This also includes information on how to run the tests and benchmarks.
 

benchmark/__init__.py

@@ -124,7 +124,7 @@ def time(self):
         try:
             self.time_statement()  # warm up
         except Exception:
-            return [math.inf]
+            return math.inf
         return min(timeit.Timer(stmt=self.time_statement).repeat(repeat=self.repeat, number=self.number))
 
     def memory(self):
@@ -604,7 +604,7 @@ def channels(cls, **kwargs):
     def depths(cls, **kwargs):
         """Tests depths for a fixed number of channels."""
         new_kwargs = dict(sizes=((32, 128, 4),),
-                          depths=(5, 6, 7, 8, 9))
+                          depths=(4, 5, 6, 7, 8, 9))
         new_kwargs.update(kwargs)
         return cls(**new_kwargs)
 
@@ -626,9 +626,6 @@ def graph(self, log=True, save=False):
 
         fig = plt.figure()
         ax = fig.gca()
-        #ax = fig.add_axes([0.1, 0.1, 0.6, 0.75])
-        #ax = fig.add_subplot(121)
-        #ax = plt.subplot(121)
 
         _, example_row_value = next(iter(self.results))
         x_axes = [[] for _ in range(len(example_row_value))]
@@ -653,17 +650,19 @@ def graph(self, log=True, save=False):
         ax.set_ylabel("Time in seconds")
         if len(self.sizes) > 1:
             ax.set_xlabel("Number of channels")
+            tag = '_channels'
         elif len(self.depths) > 1:
             ax.set_xlabel("Depth")
             if log:
                 ax.set_yscale('log')
+            tag = '_depths'
         else:
             raise RuntimeError
         start, end = ax.get_xlim()
         ax.xaxis.set_ticks(range(int(math.ceil(start)), int(math.floor(end)) + 1))
         plt.tight_layout()
         if save:
-            plt.savefig(title_string.lower().replace(' ', '_').replace(':', ''))
+            plt.savefig(title_string.lower().replace(' ', '_').replace(':', '') + tag)
         else:
             plt.show()