Merge pull request #17 from GPflow/develop

Release 0.1.0

Author: jesnie

README.md

@@ -1,2 +1,51 @@
 # check_shapes
-Library for annotating and checking tensor shapes.
+
+`check_shapes` is a library for annotating and checking tensor shapes.
+For example:
+
+```python
+import tensorflow as tf
+
+from gpflow.experimental.check_shapes import check_shapes
+
+@tf.function
+@check_shapes(
+    "features: [batch..., n_features]",
+    "weights: [n_features]",
+    "return: [batch...]",
+)
+def linear_model(features: tf.Tensor, weights: tf.Tensor) -> tf.Tensor:
+    return tf.einsum("...i,i -> ...", features, weights)
+```
+
+For more information see our [documentation](https://gpflow.github.io/check_shapes).
+
+## Installation
+
+The recommended way to install `check_shapes` is from pypi:
+
+```bash
+pip install check_shapes
+```
+
+### From source
+
+To develop `check_shapes`, check it out from GitHub:
+
+```bash
+git clone [email protected]:GPflow/check_shapes.git
+```
+
+We use [Poetry](https://python-poetry.org/) to install and manage dependencies. Follow their
+instructions for how to install Poetry itself. Then:
+
+```bash
+cd check_shapes
+poetry install
+```
+
+To check you installation run our tests:
+
+```bash
+poetry run task test
+```

pyproject.toml

@@ -2,7 +2,33 @@
 name = "check_shapes"
 version = "0.1.0"
 description = "A library for annotating and checking the shapes of tensors."
-authors = ["Jesper Nielsen <[email protected]>", "The GPflow Contributors"]
+authors = [
+    "Jesper Nielsen <[email protected]>",
+    "The GPflow Contributors",
+]
+license = "Apache-2.0"
+
+readme = "README.md"
+homepage = "https://gpflow.github.io/check_shapes"
+repository = "https://github.com/GPflow/check_shapes"
+documentation = "https://gpflow.github.io/check_shapes"
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Debuggers",
+    "Typing :: Typed",
+]
 
 [tool.poetry.dependencies]
 python = ">=3.7,<3.11"
@@ -43,15 +69,11 @@ python_version = "3.7"
 show_error_codes = true
 # First we turn on *all the checks*, and then we turn off those that are too annoying.
 strict = true
-# disallow_subclassing_any = false
-# disallow_untyped_calls = false
 disallow_untyped_decorators = false
-# ; This is needed because version 1.20.0 of NumPy introduces typing, so some ignores are necessary /
-# ; unnecessary depending on the version of numpy:
+# This is needed because version 1.20.0 of NumPy introduces typing, so some ignores are necessary /
+# unnecessary depending on the version of numpy:
 warn_unused_ignores = false
 
-
-
 [[tool.mypy.overrides]]
 module = [
     "tensorflow.*",