Skip to main content

A library for annotating and checking the shapes of tensors.

Project description

check_shapes

check_shapes is a library for annotating and checking tensor shapes. For example:

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.

Installation

The recommended way to install check_shapes is from pypi:

pip install check_shapes

From source

To develop check_shapes, check it out from GitHub:

git clone git@github.com:GPflow/check_shapes.git

We use Poetry to install and manage dependencies. Follow their instructions for how to install Poetry itself. Then:

cd check_shapes
poetry install

To check you installation run our tests:

poetry run task test

For testing with different versions of Python and dependencies, see the poetryenv script.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

check_shapes-1.1.1.tar.gz (32.7 kB view hashes)

Uploaded Source

Built Distribution

check_shapes-1.1.1-py3-none-any.whl (45.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page