Skip to content

Commit 4202bb6

Browse files
committed
Update README with AFT generator
1 parent 06a1aec commit 4202bb6

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ poetry install
2323
```
2424
## ✨ Features
2525

26-
- Consistent interface across models
27-
- Censoring support (`uniform` or `exponential`)
28-
- Easy integration with `pandas` and `NumPy`
29-
- Suitable for benchmarking survival algorithms and teaching
26+
- Consistent interface across models
27+
- Censoring support (`uniform` or `exponential`)
28+
- Easy integration with `pandas` and `NumPy`
29+
- Suitable for benchmarking survival algorithms and teaching
30+
- Accelerated Failure Time (Log-Normal) model generator
3031

3132
## 🧪 Example
3233

@@ -62,6 +63,7 @@ generate(model="thmm", n=100, qmat=[[0, 0.2, 0], [0.1, 0, 0.1], [0, 0.3, 0]],
6263
| `gen_cmm()` | Continuous-Time Multi-State Markov Model |
6364
| `gen_tdcm()` | Time-Dependent Covariate Model |
6465
| `gen_thmm()` | Time-Homogeneous Markov Model |
66+
| `gen_aft_log_normal()` | Accelerated Failure Time Log-Normal |
6567

6668

6769
```text
@@ -102,7 +104,8 @@ MIT License. See [LICENSE](LICENSE) for details.
102104
This project uses Git tags to manage releases. A GitHub Actions workflow
103105
(`version-check.yml`) verifies that the version declared in `pyproject.toml`
104106
matches the latest Git tag. If they diverge, the workflow fails and prompts a
105-
correction before merging.
107+
correction before merging. Run `python scripts/check_version_match.py` locally
108+
before creating a tag to catch issues early.
106109

107110
## 🌟 Code of Conduct
108111

0 commit comments

Comments
 (0)