Metadata-Version: 2.1
Name: obvs
Version: 0.1.1
Summary: Making Transformers Obvious
License: MIT
Author: Jamie Coombes
Author-email: jamie@example.com
Requires-Python: >=3.10.0,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: datasets (>=2.18.0,<3.0.0)
Requires-Dist: einops (>=0.7.0,<0.8.0)
Requires-Dist: fsspec (==2023.9.2)
Requires-Dist: idna (>=3.7,<4.0)
Requires-Dist: ipdb (>=0.13.13,<0.14.0)
Requires-Dist: ipykernel (>=6.28.0,<7.0.0)
Requires-Dist: ipython (>=8.22.2,<9.0.0)
Requires-Dist: jupyter (>=1.0.0,<2.0.0)
Requires-Dist: kaleido (==0.2.1)
Requires-Dist: nbstripout (>=0.7.1,<0.8.0)
Requires-Dist: nnsight (>=0.2.11,<0.3.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: plotly (>=5.18.0,<6.0.0)
Requires-Dist: tiktoken (>=0.5.2,<0.6.0)
Requires-Dist: torch (==2.2.0)
Requires-Dist: torchmetrics (>=1.3.1,<2.0.0)
Requires-Dist: transformers (>=4.37.1,<5.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Requires-Dist: zstandard (>=0.22.0,<0.23.0)
Description-Content-Type: text/markdown

# obvs

[![CI](https://github.com/obvslib/obvs/actions/workflows/main.yaml/badge.svg)](https://github.com/obvslib/obvs/actions/workflows/main.yaml)

Making Transformers Obvious

## Project cheatsheet

-   **pre-commit:** `pre-commit run --all-files`
-   **pytest:** `pytest` or `pytest -s`
-   **coverage:** `coverage run -m pytest` or `coverage html`
-   **poetry sync:** `poetry install --no-root --sync`
-   **updating requirements:** see [docs/updating_requirements.md](docs/updating_requirements.md)

## Initial project setup

1. See [docs/getting_started.md](docs/getting_started.md) or [docs/quickstart.md](docs/quickstart.md)
   for how to get up & running.
2. Check [docs/project_specific_setup.md](docs/project_specific_setup.md) for project specific setup.
3. See [docs/using_poetry.md](docs/using_poetry.md) for how to update Python requirements using
   [Poetry](https://python-poetry.org/).
4. See [docs/detect_secrets.md](docs/detect_secrets.md) for more on creating a `.secrets.baseline`
   file using [detect-secrets](https://github.com/Yelp/detect-secrets).

