Metadata-Version: 2.4
Name: nervecode
Version: 0.1.0
Summary: Intrinsic surprise scoring for PyTorch via statistical coding.
Project-URL: Homepage, https://gitlab.com/domezsolt/nervecode
Project-URL: Repository, https://gitlab.com/domezsolt/nervecode
Author: Zsolt Döme
License: MIT License
        
        Copyright (c) 2026 Nervecode Maintainers
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
License-File: LICENSE
Keywords: coding,ml,pytorch,research,surprise
Requires-Python: >=3.10
Requires-Dist: torch>=2.0
Provides-Extra: dev
Requires-Dist: mypy>=1.8; extra == 'dev'
Requires-Dist: pre-commit>=3.6; extra == 'dev'
Requires-Dist: pytest>=7; extra == 'dev'
Requires-Dist: ruff>=0.3; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocs>=1.5; extra == 'docs'
Provides-Extra: logging
Requires-Dist: loguru>=0.7; extra == 'logging'
Requires-Dist: rich>=13; extra == 'logging'
Provides-Extra: viz
Requires-Dist: matplotlib>=3.7; extra == 'viz'
Requires-Dist: seaborn>=0.13; extra == 'viz'
Description-Content-Type: text/markdown

# Nervecode Docs

This directory will contain documentation for the Nervecode project.

## Developer Setup

- Install dev tools (in your virtualenv): `pip install -e .[dev]`
- Install git hooks: `pre-commit install`
- Run on all files once: `pre-commit run --all-files`

Included hooks:
- Formatting: `ruff-format`
- Linting and import sorting: `ruff` (with `--fix`)
- Type-checking: `mypy`

## Tests

- Unit tests: `pytest tests/unit` (fast correctness checks)
- Integration tests: `pytest tests/integration` (heavier, cross-module)
- Smoke tests: `pytest tests/smoke` (repo wiring and API surface)

### Deterministic runs

- Tests auto-seed RNGs per test using `NERVECODE_SEED` (default: `1234`).
- You can control reproducibility in your own scripts via:
  ```python
  from nervecode.utils.seed import seed_everything, seed_from_env
  seed_everything(seed_from_env())
  ```

## Performance Notes

- Overhead estimates and guidance for pooled Conv2d coding: see `docs/overhead.md`.
- Scaling and tradeoffs for layer selection and coding dimension: see `docs/scaling.md`.
