Skip to content

Commit 6a6738c

Browse files
committed
doc: Update README with core histogram API feature and improve documentation references
1 parent c904ecc commit 6a6738c

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Khisto is a Python library for creating histograms using the **Khiops optimal bi
1010
- **Variable-Width Bins**: Captures dense regions with fine bins and sparse regions with wider bins.
1111
- **NumPy Compatible**: Drop-in replacement for `numpy.histogram`.
1212
- **Matplotlib Integration**: `khisto.matplotlib.hist` works like `plt.hist`.
13+
- **Core Histogram API**: Inspect every available granularity with `khisto.core.compute_histograms` and `HistogramResult`.
1314
- **Minimal Dependencies**: Only requires NumPy (matplotlib optional for plotting).
1415

1516
| Standard Gaussian | Heavy-tailed Pareto |
@@ -135,7 +136,7 @@ uv run pytest
135136

136137
## Documentation
137138

138-
See the [API](docs/API.md) and [API Comparison](docs/API_COMPARISON.md) for detailed information on available functions, parameters, and how Khisto compares to standard histogram implementations.
139+
See the [documentation index](docs/index.rst), [API comparison guide](docs/api_comparison.rst), and [demo notebook](docs/demo.ipynb) for the current API reference and usage examples.
139140

140141
## License
141142

0 commit comments

Comments
 (0)