scope 0.4.1__tar.gz → 0.4.3__tar.gz

{scope-0.4.1 → scope-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scope
-Version: 0.4.1
+Version: 0.4.3
 Summary: Metrics logging and analysis
 Home-page: http://github.com/danijar/scope
 Classifier: Intended Audience :: Science/Research

scope-0.4.3/README.md

@@ -0,0 +1,55 @@
+# 🔬 Scope
+
+Scalable metrics logging and analysis.
+
+## Features
+
+- 🚀 **Scalable:** Quickly log and view petabytes of metrics, thousands of keys, and large videos.
+- 🎞️ **Formats:** Log and view scalars, text, images, and videos. Easy to extend with custom formats.
+- 🧑🏻‍🔬 **Productivity:** Metrics viewer with focus on power users and full keyboard support.
+- ☁️ **Cloud support:** Directly write to and read from Cloud storage via pathlib interface.
+- 🍃 **Lightweight:** The writer and reader measure only ~400 lines of Python code.
+- 🧱 **Reliability:** Unit tested and used across diverse research projects.
+
+## Usage
+
+### Installation
+
+```sh
+pip install scope
+```
+
+### Writing
+
+```python
+import scope
+
+writer = scope.Writer(logdir)
+for step in range(3)
+  video = np.zeros((100, 640, 360, 3), np.uint8)
+  writer.add(step, {'foo': 42, 'bar': video, 'baz': 'Hello World'})
+writer.flush()
+```
+
+### Viewing
+
+```sh
+python -m scope.viewer --basedir ... --port 8000
+```
+
+### Reading
+
+```python
+import scope
+
+reader = scope.Reader(logdir)
+print(reader.keys())               # ('foo', 'bar', 'baz')
+
+print(reader.length('foo'))        # 3
+steps, values = reader['foo']
+print(steps)                       # np.array([0, 1, 2], np.int64)
+print(values)                      # np.array([42, 42, 42], np.float64)
+
+steps, filenames = reader['bar']
+reader.load('bar', filenames[-1])  # np.zeros((100, 640, 360, 3), np.uint8)
+```

{scope-0.4.1 → scope-0.4.3}/scope/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.4.1'
+__version__ = '0.4.3'
 
 from .reader import Reader
 from .writer import Writer

{scope-0.4.1 → scope-0.4.3}/scope/reader.py

@@ -21,7 +21,7 @@ class Reader:
     self.logdir = logdir / 'scope'
     self.fmts = {x.extension: x for x in formats}
     self.cols = {}
-    for child in sorted(logdir.glob('*')):
+    for child in sorted(self.logdir.glob('*')):
       basename, ext = child.name.rsplit('.', 1)
       key = basename.replace('-', '/')
       assert re.match(r'[a-z0-9_]+(/[a-z0-9_]+)?', key), key

{scope-0.4.1 → scope-0.4.3}/tests/test_float.py

@@ -12,9 +12,10 @@ class TestFloat:
     writer.add(0, {'foo': 12})
     writer.add(5, {'foo': 42, 'bar': np.float64(np.pi)})
     writer.flush()
-    assert {x.name for x in logdir.glob('*')} == {'foo.float', 'bar.float'}
-    assert (logdir / 'foo.float').stat().st_size == (8 + 8) * 2
-    assert (logdir / 'bar.float').stat().st_size == (8 + 8) * 1
+    filenames = (logdir / 'scope').glob('*')
+    assert {x.name for x in filenames} == {'foo.float', 'bar.float'}
+    assert (logdir / 'scope/foo.float').stat().st_size == (8 + 8) * 2
+    assert (logdir / 'scope/bar.float').stat().st_size == (8 + 8) * 1
     reader = scope.Reader(logdir)
     assert reader.keys() == tuple(sorted(['foo', 'bar']))
     assert reader.length('foo') == 2
@@ -29,9 +30,10 @@ class TestFloat:
       writer.add(step, {'foo': step, 'bar': step})
     writer.flush()
     writer.flush()  # Block until previous flush is done.
-    assert {x.name for x in logdir.glob('*')} == {'foo.float', 'bar.float'}
-    assert (logdir / 'foo.float').stat().st_size == (8 + 8) * 10
-    assert (logdir / 'bar.float').stat().st_size == (8 + 8) * 10
+    filenames = (logdir / 'scope').glob('*')
+    assert {x.name for x in filenames} == {'foo.float', 'bar.float'}
+    assert (logdir / 'scope/foo.float').stat().st_size == (8 + 8) * 10
+    assert (logdir / 'scope/bar.float').stat().st_size == (8 + 8) * 10
     reader = scope.Reader(logdir)
     assert equal(reader['foo'], (np.arange(10), np.arange(10)))
     assert equal(reader['bar'], (np.arange(10), np.arange(10)))
@@ -41,27 +43,13 @@ class TestFloat:
     writer = scope.Writer(logdir, workers=0)
     writer.add(0, {'foo/bar': 12})
     writer.flush()
-    assert {x.name for x in logdir.glob('*')} == {'foo-bar.float'}
+    filenames = (logdir / 'scope').glob('*')
+    assert {x.name for x in filenames} == {'foo-bar.float'}
     reader = scope.Reader(logdir)
     assert reader.keys() == ('foo/bar',)
     assert reader.length('foo/bar') == 1
     assert equal(reader['foo/bar'], ([0], [12]), (np.int64, np.float64))
 
-  # def test_slicing(self, tmpdir):
-  #   logdir = pathlib.Path(tmpdir)
-  #   writer = scope.Writer(logdir, workers=0)
-  #   writer.add(0, {'foo': 12})
-  #   writer.add(5, {'foo': 42})
-  #   writer.flush()
-  #   reader = scope.Reader(logdir)
-  #   assert equal(reader['foo', 0], ([0], [12]))
-  #   assert equal(reader['foo', :2], ([0], [12]))
-  #   assert equal(reader['foo', :5], ([0], [12]))
-  #   assert equal(reader['foo', :6], ([0, 5], [12, 42]))
-  #   assert equal(reader['foo', 1:6], ([5], [42]))
-  #   assert equal(reader['foo', :-1], ([], []))
-  #   assert equal(reader['foo', 7:], ([], []))
-
 
 def equal(actuals, references, dtypes=None):
   dtypes = dtypes or [x.dtype for x in actuals]

{scope-0.4.1 → scope-0.4.3}/tests/test_image.py

@@ -14,9 +14,9 @@ class TestImage:
     writer.add(0, {'foo': img1})
     writer.add(5, {'foo': img2})
     writer.flush()
-    assert {x.name for x in logdir.glob('*')} == {'foo.png'}
-    assert (logdir / 'foo.png' / 'index').stat().st_size == (8 + 8) * 2
-    assert len(list((logdir / 'foo.png').glob('*'))) == 1 + 2
+    assert {x.name for x in (logdir / 'scope').glob('*')} == {'foo.png'}
+    assert (logdir / 'scope/foo.png/index').stat().st_size == (8 + 8) * 2
+    assert len(list((logdir / 'scope/foo.png').glob('*'))) == 1 + 2
     reader = scope.Reader(logdir)
     assert reader.keys() == ('foo',)
     assert reader.length('foo') == 2
@@ -33,11 +33,11 @@ class TestImage:
         writer.add(step, {key: np.full((64, 128, 3), step, np.uint8)})
     writer.flush()
     writer.flush()  # Block until previous flush is done.
-    assert {x.name for x in logdir.glob('*')} == {
+    assert {x.name for x in (logdir / 'scope').glob('*')} == {
         'foo.png', 'bar.png', 'baz.png'}
     for key in ('foo', 'bar', 'baz'):
-      assert (logdir / f'{key}.png' / 'index').stat().st_size == (8 + 8) * 5
-      assert len(list((logdir / f'{key}.png').glob('*'))) == 1 + 5
+      assert (logdir / f'scope/{key}.png/index').stat().st_size == (8 + 8) * 5
+      assert len(list((logdir / f'scope/{key}.png').glob('*'))) == 1 + 5
     reader = scope.Reader(logdir)
     assert reader.keys() == tuple(sorted(['foo', 'bar', 'baz']))
     for key in ('foo', 'bar', 'baz'):
@@ -55,34 +55,11 @@ class TestImage:
     writer = scope.Writer(logdir, workers=0)
     writer.add(0, {'foo/bar': img})
     writer.flush()
-    assert {x.name for x in logdir.glob('*')} == {'foo-bar.png'}
-    assert len(list((logdir / 'foo-bar.png').glob('*'))) == 1 + 1
+    assert {x.name for x in (logdir / 'scope').glob('*')} == {'foo-bar.png'}
+    assert len(list((logdir / 'scope/foo-bar.png').glob('*'))) == 1 + 1
     reader = scope.Reader(logdir)
     assert reader.keys() == ('foo/bar',)
     assert reader.length('foo/bar') == 1
     _, filenames = reader['foo/bar']
     assert len(filenames) == 1
     assert (reader.load('foo/bar', filenames[0]) == img).all()
-
-  # def test_slicing(self, tmpdir):
-  #   logdir = pathlib.Path(tmpdir)
-  #   writer = scope.Writer(logdir, workers=0)
-  #   img1 = np.ones((64, 128, 3), np.uint8) + 12
-  #   img2 = np.ones((64, 128, 3), np.uint8) + 255
-  #   writer.add(0, {'foo': img1})
-  #   writer.add(5, {'foo': img2})
-  #   writer.flush()
-  #   assert {x.name for x in logdir.glob('*')} == {'foo.png'}
-  #   assert (logdir / 'foo.png' / 'index').stat().st_size == (8 + 8) * 2
-  #   reader = scope.Reader(logdir)
-  #   assert reader.keys() == ('foo',)
-  #   assert reader.length('foo') == 2
-  #   steps, values = reader['foo']
-  #   assert (steps == np.array([0, 5])).all()
-  #   assert (values == np.array([img1, img2])).all()
-  #   assert (reader['foo', 0][1] == img1[None]).all()
-  #   assert (reader['foo', :5][1] == img1[None]).all()
-  #   assert (reader['foo', :6][1] == np.array([img1, img2])).all()
-  #   assert (reader['foo', 1:6][1] == img2[None]).all()
-  #   assert reader['foo', :-1][1] == ()
-  #   assert reader['foo', 6:][1] == ()

{scope-0.4.1 → scope-0.4.3}/tests/test_video.py

@@ -14,12 +14,12 @@ class TestVideo:
     writer.add(0, {'foo': vid1})
     writer.add(5, {'foo': vid2})
     writer.flush()
-    names = {x.name for x in logdir.glob('*')}
+    names = {x.name for x in (logdir / 'scope').glob('*')}
     assert len(names) == 1
     name = list(names)[0]
     assert name in ('foo.mp4', 'foo.webm')
-    assert (logdir / name / 'index').stat().st_size == (8 + 8) * 2
-    assert len(list((logdir / name).glob('*'))) == 1 + 2
+    assert (logdir / 'scope' / name / 'index').stat().st_size == (8 + 8) * 2
+    assert len(list((logdir / 'scope' / name).glob('*'))) == 1 + 2
     reader = scope.Reader(logdir)
     assert reader.keys() == ('foo',)
     assert reader.length('foo') == 2