Check-shapes

Latest version: v1.1.1

Safety actively analyzes 682449 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

1.1.2

<INSERT SMALL BLURB ABOUT RELEASE FOCUS AREA AND POTENTIAL TOOLCHAIN CHANGES>

Breaking Changes

* <DOCUMENT BREAKING CHANGES HERE>
* <THIS SECTION SHOULD CONTAIN API AND BEHAVIORAL BREAKING CHANGES>

Known Caveats

* <CAVEATS REGARDING THE RELEASE (BUT NOT BREAKING CHANGES).>
* <ADDING/BUMPING DEPENDENCIES SHOULD GO HERE>
* <KNOWN LACK OF SUPPORT ON SOME PLATFORM SHOULD GO HERE>

Major Features and Improvements

* <INSERT MAJOR FEATURE HERE, USING MARKDOWN SYNTAX>
* <IF RELEASE CONTAINS MULTIPLE FEATURES FROM SAME AREA, GROUP THEM TOGETHER>

Bug Fixes and Other Changes

* <SIMILAR TO ABOVE SECTION, BUT FOR OTHER IMPORTANT CHANGES / BUG FIXES>
* <IF A CHANGE CLOSES A GITHUB ISSUE, IT SHOULD BE DOCUMENTED HERE>
* <NOTES SHOULD BE GROUPED PER AREA>

Thanks to our Contributors

This release contains contributions from:

<INSERT>, <NAME>, <HERE>, <USING>, <GITHUB>, <HANDLE>

1.1.1

Fix missing dependency in `1.1.0`.

Bug Fixes and Other Changes

* Fix missing dependency on `dropstackframe`.

Thanks to our Contributors

This release contains contributions from:

jesnie

1.1.0

Maintenance release. Mostly importantly adds support for Python 3.11, but also adds a couple of
small features.

Major Features and Improvements

* Adds support for:
- Python 3.11
- PyTorch 2.0
- TensorFlow 2.12
- JAX 0.4
* Adds support for annotating `functools.partial` functions.
* Hides `check_shapes` stack frames from stack traces, to be less spammy.

Thanks to our Contributors

This release contains contributions from:

jesnie, uri-granta

1.0.0

No actual changes from release `0.2.0`.

0.2.0

This release makes `check_shapes` independent of the underlying framework.

Major Features and Improvements

* Made `check_shapes` independent of tensor framework:
- Made NumPy optional.
- Made TensorFlow optional.
- Made TensorFlow-Probability optional.
- Added support for JAX.
- Added support for PyTorch.
* Added benchmarks and documentation of overhead imposed by `check_shapes`.

Bug Fixes and Other Changes

* Fixed bug related to `tf.saved_model` and methods wrapped in `check_shapes`.
* Added support for TensorFlow-Probability `_TensorCoercible` objects.

Thanks to our Contributors

This release contains contributions from:

jesnie

0.1.0

Initial import from [GPflow](https://github.com/GPflow/GPflow) and experimental release.

Thanks to our Contributors

This release contains contributions from:

jesnie


How to make a new `check_shapes` release

1. Bump the version numbers in the `develop` branch, in *BOTH* the
[`pyproject.toml`](https://github.com/GPflow/check_shapes/blob/develop/pyproject.toml) file
and the
[`__init__`](https://github.com/GPflow/check_shapes/blob/develop/check_shapes/__init__.py).

2. Update [RELEASE.md](https://github.com/GPflow/check_shapes/blob/develop/RELEASE.md).
- Make sure it contains up-to-date release notes for the next release.
* They should cover all changes that are visible to library users on the `develop` branch
since the most recent release.
* They should make clear to users whether they might benefit from this release and what
backwards incompatibilities they might face.
- Make sure the release version matches what you were setting elsewhere.
- Make a new copy of the template, to prepare for the next release.

3. Create a release PR from `develop` to `main`.
- **Make a merge commit. DO NOT SQUASH-MERGE.**
- If you squash-merge, `main` will be *ahead* of develop (by the squash-merge commit). This
means we’ll end up with merge conflicts at the following release!

4. Go to the [release page on GitHub](https://github.com/GPflow/check_shapes/releases/new) and
create a release for a tag “v{VERSION}” (e.g., for version 2.1.3 the tag needs to be `v2.1.3`) to
`main` branch. Copy the release notes into the description field!

5. You are almost done now! Go to https://github.com/GPflow/check_shapes/actions and monitor the
tests for your newly-created release passed and the job for pushing the pip package succeeded.
GitHub Actions are triggered by the publication of the release above.

6. Take a break; wait until the new release
[shows up on PyPi](https://pypi.org/project/check_shapes/#history).


Done done! Go and celebrate our hard work :)

Links

Releases

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.