Add basic proto files and logic

Author: Danqing Liu

.travis.yml

@@ -0,0 +1,10 @@
+language: python
+python:
+  - '2.7'
+  - '3.5'
+  - '3.6'
+install: make bootstrap
+script: make test
+branches:
+  except:
+    - /^v[0-9]/

Makefile

@@ -0,0 +1,20 @@
+.PHONY: protoc
+protoc:
+	@protoc -I=tinyboard/proto --python_out=tinyboard/proto tinyboard/proto/*.proto
+
+.PHONY: lint
+lint:
+	@flake8 tinyboard
+
+.PHONY: clean
+clean:
+	@find . -type f -name '*.pyc' -delete
+
+.PHONY: bootstrap
+bootstrap:
+	@pip install -r requirements.txt
+	@python setup.py develop
+
+.PHONY: test
+test: lint
+	py.test --cov-report term-missing --cov=tinyboard tests/

README.md

@@ -1 +1,3 @@
-# tinyboard
+# TinyBoard
+
+TinyBoard is TensorBoard for PyTorch and other popular deep learning frameworks.

setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup, find_packages
+
+__version__ = '0.1.0'
+
+requires = [
+    'numpy>=1.13.1',
+    'pillow>=4.2.1',
+]
+
+pytorch_requires = ['torch']
+
+setup(
+    name='tinyboard',
+    version=__version__,
+    description='Universal TensorBoard visualization library',
+    author='TinyMind',
+    author_email='[email protected]',
+    url='https://github.com/mind/tinyboard',
+    packages=find_packages(exclude=('tests', 'tests.*',)),
+    install_requires=requires,
+    extras_require={
+        'pytorch': pytorch_requires,
+    },
+    license='Apache 2.0',
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+    ]
+)

tests/__init__.py

@@ -0,0 +1,33 @@
+from __future__ import absolute_import, division, print_function
+
+import io
+import struct
+import wave
+
+from tinyboard.proto.summary_pb2 import Summary
+
+
+def audio(tag, tensor, sample_rate=44100):
+    tensor_list = [int(32767.0 * x) for x in tensor]
+    fio = io.BytesIO()
+    Wave_write = wave.open(fio, 'wb')
+    Wave_write.setnchannels(1)
+    Wave_write.setsampwidth(2)
+    Wave_write.setframerate(sample_rate)
+    tensor_enc = b''
+    for v in tensor_list:
+        tensor_enc += struct.pack('<h', v)
+
+    Wave_write.writeframes(tensor_enc)
+    Wave_write.close()
+    audio_string = fio.getvalue()
+    fio.close()
+    audio = Summary.Audio(
+        sample_rate=sample_rate,
+        num_channels=1,
+        length_frames=len(tensor_list),
+        encoded_audio_string=audio_string,
+        content_type='audio/wav',
+    )
+
+    return Summary(value=[Summary.Value(tag=tag, audio=audio)])

tests/core/test_compat.py

@@ -0,0 +1,27 @@
+from __future__ import absolute_import, division, print_function
+
+import logging
+import re
+
+INVALID_TAG_CHARS = re.compile(r'[^-/\w\.]')
+
+
+def clean_tag(name):
+    """Convert old tag names (pre-TF 1.3) to new ones.
+
+    Historically, the first argument to summary ops was a tag, which allowed
+    arbitrary characters. Now we are changing the first argument to be the node
+    name. This function replaces all illegal characters with _s, and logs a
+    warning. It also strips leading slashes from the name.
+
+    :param string name: The original name of the tag.
+    :returns string: The cleaned tag name.
+    """
+    if not name:
+        return ''
+    new_name = INVALID_TAG_CHARS.sub('_', name).lstrip('/')
+    if new_name != name:
+        logging.info('Summary name {} illegal; using {} instead.'.format(
+            name, new_name,
+        ))
+    return new_name

tinyboard/__init__.py

@@ -0,0 +1,43 @@
+from __future__ import absolute_import, division, print_function
+
+import numpy as np
+
+from tinyboard.core.compat import clean_tag
+from tinyboard.proto.summary_pb2 import HistogramProto
+from tinyboard.proto.summary_pb2 import Summary
+
+
+def histogram(name, tensor, bins, collections=None):
+    """Prepare a summary proto containing a histogram.
+
+    :param string name: The name of the histogram.
+    :param Tensor tensor: The tensor of the histogram. Can be of any shape.
+    :param int|list<int> bins: If an int, it defines the number of equal-width
+        bins in the given range. If a sequence, it defines the bin edges,
+        including the rightmost edge, allowing for non-uniform bin widths.
+    :param list<string> collections: Optional collections keys. The new summary
+        will be added to these collections.
+    :returns Summary: The summary proto containing the histogram.
+    """
+    name = clean_tag(name)
+    hist = _make_histogram(tensor.astype(float), bins)
+    return Summary(value=[Summary.Value(tag=name, histo=hist)])
+
+
+def _make_histogram(values, bins):
+    """Convert values into a histogram proto.
+
+    :param array_like values: The values over which the histogram is computed.
+    :param int|list<int> bins: If an int, it defines the number of equal-width
+        bins in the given range. If a sequence, it defines the bin edges,
+        including the rightmost edge, allowing for non-uniform bin widths.
+    :returns HistogramProto: The histogram proto.
+    """
+    values = values.reshape(-1)
+    counts, limits = np.histogram(values, bins=bins)
+    return HistogramProto(
+        min=values.min(), max=values.max(),
+        num=len(values),
+        sum=values.sum(), sum_squares=values.dot(values),
+        bucket_limit=limits[1:], bucket=counts,
+    )

tinyboard/core/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import absolute_import, division, print_function
+
+from tinyboard.core.compat import clean_tag
+from tinyboard.proto.summary_pb2 import Summary
+
+
+def scalar(name, scalar, collections=None):
+    """Prepare a summary proto containing a scalar value.
+
+    :param string name: The name of the scalar series.
+    :param Tensor scalar: The scalar value. Should contain a single value.
+    :param list<string> collections: Optional collections keys. The new summary
+        will be added to these collections.
+    :returns Summary: The summary proto containing the scalar value.
+    :raises ValueError: If the incoming tensor has the wrong shape/type.
+    """
+    name = clean_tag(name)
+    return Summary(value=[Summary.Value(tag=name, simple_value=float(scalar))])

tinyboard/core/audio.py

@@ -0,0 +1,21 @@
+from __future__ import absolute_import, division, print_function
+
+from tinyboard.proto.summary_pb2 import Summary, SummaryMetadata
+from tinyboard.proto.tensor_pb2 import TensorProto
+
+
+def text(name, text):
+    """Prepare a summary proto containing text.
+
+    :param string name: The name of the text.
+    :param string text: The text.
+    :returns Summary: The summary proto containing the text.
+    """
+    plugin_data = [SummaryMetadata.PluginData(plugin_name='text')]
+    meta = SummaryMetadata(plugin_data=plugin_data)
+    tensor = TensorProto(
+        dtype='DT_STRING', string_val=[text.encode(encoding='utf_8')],
+    )
+    return Summary(value=[
+        Summary.Value(node_name=name, metadata=meta, tensor=tensor),
+    ])

tinyboard/core/compat.py

@@ -0,0 +1,3 @@
+# TensorBoard Protos
+
+Protobuf definitions in this folder are mostly copied from the [TensorFlow framework](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/core/framework), Apache 2.0 licensed from TensorFlow authors.

tinyboard/core/histogram.py

@@ -0,0 +1,30 @@
+syntax = "proto3";
+
+package tinyboard;
+
+option cc_enable_arenas = true;
+option java_outer_classname = "ResourceHandle";
+option java_multiple_files = true;
+option java_package = "ai.tinymind.tinyboard";
+
+// Protocol buffer representing a handle to a tensorflow resource. Handles are
+// not valid across executions, but can be serialized back and forth from within
+// a single run.
+message ResourceHandleProto {
+  // Unique name for the device containing the resource.
+  string device = 1;
+
+  // Container in which this resource is placed.
+  string container = 2;
+
+  // Unique name of this resource.
+  string name = 3;
+
+  // Hash code for the type of the resource. Is only valid in the same device
+  // and in the same execution.
+  uint64 hash_code = 4;
+
+  // For debug-only, the name of the type pointed to by this handle, if
+  // available.
+  string maybe_type_name = 5;
+};