Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
d8793d9
feat: close #246
uriahf Dec 22, 2025
87702d3
feat: close #248
uriahf Dec 22, 2025
d4d3100
feat: close #249
uriahf Dec 22, 2025
3bb78da
feat: close #250
uriahf Dec 22, 2025
fa7e7ac
feat: close #251
uriahf Dec 22, 2025
efe238f
fix: migrate code from pandas to polars and remove `reference_group_n…
uriahf Dec 22, 2025
1c6f216
fix: close #253
uriahf Dec 22, 2025
e1d9c32
feat: close #252
uriahf Dec 22, 2025
be49a50
feat: close #255
uriahf Dec 22, 2025
e0032db
build: Add AGENTS.md file
uriahf Dec 23, 2025
2672757
feat: Add smoothed calibration curve
google-labs-jules[bot] Dec 23, 2025
3d0adf3
Merge pull request #260 from uriahf/feat/smoothed-calibration-curve-8…
uriahf Dec 23, 2025
5cf0a96
feat: Add create_calibration_curve_times function
google-labs-jules[bot] Dec 23, 2025
2488466
Merge pull request #264 from uriahf/feat/calibration-curve-times-1091…
uriahf Dec 23, 2025
b56de94
fix: Improve data loading logic for calibration curves
google-labs-jules[bot] Dec 23, 2025
41ff8c4
fix: Improve data loading logic for calibration curves
google-labs-jules[bot] Dec 23, 2025
99c0487
Merge pull request #266 from uriahf/feat/calibration-curve-times-1091…
uriahf Dec 23, 2025
c5ad925
feat: Pass ty check and update AGENTS.md
google-labs-jules[bot] Dec 23, 2025
04f4627
Merge pull request #267 from uriahf/jules/ty-fixes-322255806096583053
uriahf Dec 23, 2025
c570bff
Refactor helpers module into processing
google-labs-jules[bot] Dec 23, 2025
15feab1
Merge pull request #268 from uriahf/refactor-helpers-module-729349113…
uriahf Dec 24, 2025
f8dd249
build: bump version and update __init__.py
uriahf Dec 24, 2025
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
77 changes: 77 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# rtichoke Agent Information

This document provides guidance for AI agents working on the `rtichoke` repository.

## Development Environment

To set up the development environment, follow these steps:

1. **Install `uv`**: If you don't have `uv` installed, please follow the official installation instructions.
2. **Create a virtual environment**: Use `uv venv` to create a virtual environment.
3. **Install dependencies**: Install the project dependencies, including the `dev` dependencies, with the following command:

```bash
uv pip install -e .[dev]
```

## Running Tests

The test suite is run using `pytest`. To run the tests, use the following command:

```bash
uv run pytest
```

## Coding Conventions

### Functional Programming

Strive to use a functional programming style as much as possible. Avoid side effects and mutable state where practical.

### Docstrings

All exported functions must have NumPy-style docstrings. This is to ensure that the documentation is clear, consistent, and can be easily parsed by tools like `quartodoc`.

Example of a NumPy-style docstring:

```python
def my_function(param1, param2):
"""Summary of the function's purpose.

Parameters
----------
param1 : int
Description of the first parameter.
param2 : str
Description of the second parameter.

Returns
-------
bool
Description of the return value.
"""
# function body
return True
```

## Pre-commit Hooks

This repository uses pre-commit hooks to ensure code quality and consistency. The following hooks are configured:

* **`ruff-check`**: A linter to check for common errors and style issues.
* **`ruff-format`**: A code formatter to ensure a consistent code style.
* **`uv-lock`**: A hook to keep the `uv.lock` file up to date.

Before committing, please ensure that the pre-commit hooks pass. You can run them manually on all files with `pre-commit run --all-files`.

## Documentation

The documentation for this project is built using `quartodoc`. The documentation is automatically built and deployed via GitHub Actions. There is no need to build the documentation manually.

## Type Checking

This project uses `ty` for type checking. To check for type errors, run the following command:

```bash
uv run ty check src tests
```
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ dependencies = [
"polarstate==0.1.8",
"marimo>=0.17.0",
"pyarrow>=21.0.0",
"statsmodels>=0.14.0",
]
name = "rtichoke"
version = "0.1.25"
version = "0.1.26"
description = "interactive visualizations for performance of predictive models"
readme = "README.md"

Expand Down
7 changes: 4 additions & 3 deletions src/rtichoke/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
)
from rtichoke.discrimination.gains import plot_gains_curve as plot_gains_curve

# from rtichoke.calibration.calibration import (
# create_calibration_curve as create_calibration_curve,
# )
from rtichoke.calibration.calibration import (
create_calibration_curve as create_calibration_curve,
create_calibration_curve_times as create_calibration_curve_times,
)

from rtichoke.utility.decision import (
create_decision_curve as create_decision_curve,
Expand Down
4 changes: 4 additions & 0 deletions src/rtichoke/calibration/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""
Subpackage for Calibration
"""

from .calibration import create_calibration_curve, create_calibration_curve_times

__all__ = ["create_calibration_curve", "create_calibration_curve_times"]
Loading