Metadata-Version: 2.4
Name: invrs_utils
Version: 1.4.1
Summary: Miscellaneous utilities for the invrs-io ecosystem
Author-email: "Martin F. Schubert" <mfschubert@gmail.com>
Maintainer-email: "Martin F. Schubert" <mfschubert@gmail.com>
License-Expression: MIT
Keywords: topology,optimization,jax,inverse design
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jax>=0.4.36
Requires-Dist: pandas
Requires-Dist: totypes
Requires-Dist: tqdm
Requires-Dist: types-tqdm
Provides-Extra: tests
Requires-Dist: parameterized; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-subtests; extra == "tests"
Requires-Dist: invrs-gym; extra == "tests"
Requires-Dist: invrs-opt; extra == "tests"
Provides-Extra: dev
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: darglint; extra == "dev"
Requires-Dist: invrs_utils[tests]; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Dynamic: license-file

# invrs-utils - Miscellaneous utilities
[![Continuous integration](https://github.com/invrs-io/utils/actions/workflows/build-ci.yml/badge.svg)](https://github.com/invrs-io/utils/actions)
[![PyPI version](https://img.shields.io/pypi/v/invrs-utils)](https://pypi.org/project/invrs-utils/)

This package is a collection of utilities that may be useful, but do not have fundamental roles in the invrs-io ecosystem. These currently include,

- `experiment.checkpoint`: Defines a simple checkpoint manager with an [orbax](https://github.com/google/orbax)-like API.
- `experiment.sweep`: Functions to construct experiments involving hyperparameter sweeps.
- `experiment.data`: Functions to load and summarize data from experiments.
- `experiment.work_unit`: Provides a function to run a single work unit in an experiment.

## Install
```
pip install invrs-utils
```
