scope 0.4.2__tar.gz → 0.4.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scope
-Version: 0.4.2
+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.2 → scope-0.4.3}/scope/__init__.py

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