Added the ability to not run iisignature benchmarks.

Author: patrick-kidger

CHANGELOG.txt

@@ -1,4 +1,4 @@
-1.1.7
+1.2.0
 -----
 Added support for PyTorch 1.4.0
 Added 'scalar_term' argument to the 'signature' function (and by extension many other functions that take signatures as arguments.)
@@ -7,6 +7,7 @@ Made SignatureToLogSignature and LogSignature classes deepcopyable.
 Fixed the repr for LogSignature and SignatureToLogSignature.
 Fixed some parallelism to achieve even greater speedups.
 Released the Global Interpreter Lock during execution of Signatory's functions.
+Bumped the minor version because frankly we've changed a lot since the 1.1.0 release!
 
 1.1.6
 -----

README.rst

@@ -31,7 +31,7 @@ Install via:
 
     pip install signatory==<SIGNATORY_VERSION>.<TORCH_VERSION>
 
-where ``<SIGNATORY_VERSION>`` is the version of Signatory you would like to download (the most recent version is 1.1.7) and ``<TORCH_VERSION>`` is the version of PyTorch you are using.
+where ``<SIGNATORY_VERSION>`` is the version of Signatory you would like to download (the most recent version is 1.2.0) and ``<TORCH_VERSION>`` is the version of PyTorch you are using.
 
 
     For example, if you are using PyTorch 1.3.0 and want Signatory 1.1.4, then you should run:
@@ -75,7 +75,7 @@ For further examples, see the `documentation <https://signatory.readthedocs.io/e
 
 Citation
 ########
-If you found this library useful in your research, please consider citing
+If you found this library useful in your research, please consider citing `the paper <https://arxiv.org/abs/2001.00706>`__.
 
 .. code-block:: bibtex
 

benchmark/benchmark.py

@@ -136,7 +136,7 @@ class small(object):
 class BenchmarkRunner(object):
     """Runs all functions across all libraries and records their times or memory usage for multiple sizes and depths."""
 
-    def __init__(self, type_, test_esig, test_signatory_gpu, measure, fns, **kwargs):
+    def __init__(self, type_, test_esig, test_iisignature, test_signatory_gpu, measure, fns, **kwargs):
         assert type_ in Types
         assert measure in Measurables
         assert fns in Functions
@@ -151,6 +151,7 @@ def __init__(self, type_, test_esig, test_signatory_gpu, measure, fns, **kwargs)
         self.sizes = type_.sizes
         self.depths = type_.depths
         self.test_esig = test_esig
+        self.test_iisignature = test_iisignature
         self.test_signatory_gpu = test_signatory_gpu
         self.measure = measure
         self.fns = fns
@@ -199,6 +200,8 @@ def _run_test(self, fn_name, fn_dict, size, depth, running):
                 continue
             if (not self.test_signatory_gpu) and (library_name is Columns.signatory_gpu_str):
                 continue
+            if (not self.test_iisignature) and (library_name is Columns.iisignature_str):
+                continue
 
             result = math.inf
             if running:
@@ -214,7 +217,9 @@ def _run_test(self, fn_name, fn_dict, size, depth, running):
                     running = False
             column_results[library_name] = result
 
-        other_best = column_results[Columns.iisignature_str]
+        other_best = math.inf
+        if self.test_iisignature:
+            other_best = min(column_results[Columns.iisignature_str], other_best)
         if self.test_esig:
             other_best = min(column_results[Columns.esig_str], other_best)
         try:

command.py

@@ -66,7 +66,9 @@ def main():
                              help="All other arguments are forwarded on to pytest.")
 
     benchmark_parser.add_argument('-e', '--noesig', action='store_false', dest='test_esig',
-                                  help="Skip esig tests as esig is typically very slow.")
+                                  help="Skip esig tests.")
+    benchmark_parser.add_argument('-i', '--noiisignature', action='store_false', dest='test_iisignature',
+                                  help="Skip iisignature tests.")
     benchmark_parser.add_argument('-g', '--nogpu', action='store_false', dest='test_signatory_gpu',
                                   help="Skip Signatory GPU tests.")
     benchmark_parser.add_argument('-m', '--measure', choices=('time', 'memory'), default='time',
@@ -195,6 +197,7 @@ def benchmark(args):
     try:
         runner = bench.BenchmarkRunner(type_=type_,
                                        test_esig=args.test_esig,
+                                       test_iisignature=args.test_iisignature,
                                        test_signatory_gpu=args.test_signatory_gpu,
                                        measure=measure,
                                        fns=fns)

docs/pages/miscellaneous/citation.rst

@@ -2,7 +2,7 @@
 
 Citation
 ########
-If you found this library useful in your research, please consider citing
+If you found this library useful in your research, please consider citing `the paper <https://arxiv.org/abs/2001.00706>`__.
 
 .. code-block:: bibtex
 

src/signatory/__init__.py

@@ -14,8 +14,8 @@
 # =========================================================================
 """Signatory: Differentiable computations of the signature and logsignature transforms, on both CPU and GPU.
 
-Project homepage: github.com/patrick-kidger/signatory
-Documentation: signatory.readthedocs.io
+Project homepage: https://github.com/patrick-kidger/signatory
+Documentation: https://signatory.readthedocs.io
 """
 
 
@@ -56,6 +56,6 @@
                       all_words)
 
 
-__version__ = "1.1.7"
+__version__ = "1.2.0"
 
 del torch