Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,40 +144,46 @@ Important boundaries:

See [behavior conventions](docs/conventions.md) for detailed compatibility notes.

## Examples and notebooks
## Examples

Runnable examples live in [`docs/examples`](docs/examples):
Runnable, self-checking example scripts live in
[`examples/vignettes`](examples/vignettes), mirroring the R NNS vignettes. They
are exercised in CI by `tests/docs/test_vignette_examples.py`, so they stay in
sync with the package.

| Topic | Script |
|---|---|
| Partial moments | [`partial_moments.py`](docs/examples/partial_moments.py) |
| Dependence | [`dependence.py`](docs/examples/dependence.py) |
| Distributions and ANOVA | [`distributions_anova.py`](docs/examples/distributions_anova.py) |
| Regression | [`regression.py`](docs/examples/regression.py) |
| Classification | [`classification.py`](docs/examples/classification.py) |
| Forecasting | [`forecasting.py`](docs/examples/forecasting.py) |
| Overview | [`overview.py`](examples/vignettes/overview.py) |
| Partial moments | [`partial_moments.py`](examples/vignettes/partial_moments.py) |
| Descriptive and distributional tools | [`descriptive_distributional_tools.py`](examples/vignettes/descriptive_distributional_tools.py) |
| Dependence and nonlinear association | [`dependence_nonlinear_association.py`](examples/vignettes/dependence_nonlinear_association.py) |
| Normalization and rescaling | [`normalization_rescaling.py`](examples/vignettes/normalization_rescaling.py) |
| Hypothesis, ANOVA and stochastic superiority | [`hypothesis_anova_stochastic_superiority.py`](examples/vignettes/hypothesis_anova_stochastic_superiority.py) |
| Regression, boosting, stacking and causality | [`regression_boosting_stacking_causality.py`](examples/vignettes/regression_boosting_stacking_causality.py) |
| Time series forecasting | [`time_series_forecasting.py`](examples/vignettes/time_series_forecasting.py) |
| Simulation, bootstrap and risk-neutral | [`simulation_bootstrap_riskneutral.py`](examples/vignettes/simulation_bootstrap_riskneutral.py) |
| Portfolio and stochastic dominance | [`portfolio_stochastic_dominance.py`](examples/vignettes/portfolio_stochastic_dominance.py) |

Run one example:

```bash
uv run python docs/examples/partial_moments.py
uv run python examples/vignettes/partial_moments.py
```

Run all script examples:
Run all of them with a PASS/FAIL summary:

```bash
for example in docs/examples/*.py; do uv run python "$example"; done
uv run python examples/run_all_vignettes.py
```

Notebook workflows are also available under [`docs/examples/notebooks`](docs/examples/notebooks).

## Documentation

- [API reference manual](docs/api_reference.md)
- [API status and known gaps](docs/api_status.md)
- [Behavior conventions and intentional divergences](docs/conventions.md)
- [Parity target, cache regeneration, and automation](docs/parity.md)
- [Benchmarks](docs/benchmarks.md)
- [Examples](docs/examples/README.md)
- [Examples](examples/vignettes)

## Development

Expand Down
2 changes: 1 addition & 1 deletion docs/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,5 +440,5 @@ When a public API changes:
1. Update or add the function docstring in `src/nns`.
2. Update implementation status in `docs/api_status.md` if parity or support changed.
3. Run `uv run python scripts/generate_api_reference.py`.
4. Review examples in `docs/examples` if the signature or return shape changed.
4. Review examples in `examples/vignettes` if the signature or return shape changed.
5. Confirm `README.md` still points to the manual and the correct API status page.
51 changes: 0 additions & 51 deletions docs/examples/README.md

This file was deleted.

74 changes: 0 additions & 74 deletions docs/examples/classification.py

This file was deleted.

39 changes: 0 additions & 39 deletions docs/examples/dependence.py

This file was deleted.

53 changes: 0 additions & 53 deletions docs/examples/distributions_anova.py

This file was deleted.

53 changes: 0 additions & 53 deletions docs/examples/forecasting.py

This file was deleted.

Loading
Loading