Skip to content

Commit 8e9801c

Browse files
authored
Revise README for clarity and additional information
Updated README to improve formatting and add details about the collaborative project and regulatory science tools.
1 parent 6289f72 commit 8e9801c

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

README.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<p align="center">
2+
</picture>
23
<img src=docs/source/logo_firecamp.png width="200">
4+
</picture>
35
</p>
4-
5-
# Deep survival analysis made easy
6+
<h1 align="center">
7+
Deep survival analysis made easy
8+
</h1>
69

710
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
811
[![Python](https://img.shields.io/pypi/pyversions/torchsurv?label=Python)](https://pypi.org/project/torchsurv/)
@@ -13,26 +16,18 @@ https://pypi.org/project/torchsurv/)
1316
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/torchsurv.svg?label=Conda%20downloads)](
1417
https://anaconda.org/conda-forge/torchsurv)
1518

16-
1719
![CodeQC](https://github.com/Novartis/torchsurv/actions/workflows/codeqc.yml/badge.svg?branch=main)
1820
![Docs](https://github.com/Novartis/torchsurv/actions/workflows/docs.yml/badge.svg?branch=main)
1921
[![CodeFactor](https://www.codefactor.io/repository/github/novartis/torchsurv/badge/main)](https://www.codefactor.io/repository/github/novartis/torchsurv/overview/main)
2022
[![JOSS](https://joss.theoj.org/papers/02d7496da2b9cc34f9a6e04cabf2298d/status.svg)](https://joss.theoj.org/papers/02d7496da2b9cc34f9a6e04cabf2298d)
2123
[![License](https://img.shields.io/badge/License-MIT-black)](https://opensource.org/licenses/MIT)
2224
[![Documentation](https://img.shields.io/badge/GithubPage-Sphinx-blue)](https://opensource.nibr.com/torchsurv/)
2325

24-
25-
2626
`TorchSurv` is a Python package that serves as a companion tool to perform deep survival modeling within the `PyTorch` environment. Unlike existing libraries that impose specific parametric forms on users, `TorchSurv` enables the use of custom `PyTorch`-based deep survival models. With its lightweight design, minimal input requirements, full `PyTorch` backend, and freedom from restrictive survival model parameterizations, `TorchSurv` facilitates efficient survival model implementation, particularly beneficial for high-dimensional input data scenarios.
2727

28-
__If you find this repository useful, please give us a star!__ 🌟 ⭐ 🌟
28+
If you find this repository useful, please give us a star! 🌟 ⭐ 🌟
2929

30-
## A collaborative project
31-
32-
This package was developed by **Novartis** and the **US Food and Drug Administration (FDA)** as part of a **research collaboration** agreement on [radiogenomics](https://www.medrxiv.org/content/10.1101/2023.08.30.23294367v1.full.pdf).
33-
34-
`TorchSurv` is now part of the **FDA’s [Regulatory Science Tool Catalog](https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis)!** 🎉
35-
<br>For more information, please consult [this section](#disclaimer-regarding-the-catalog-of-regulatory-science-tools).
30+
---
3631

3732
## TL;DR
3833

@@ -65,11 +60,35 @@ cindex.p_value(method="noether", alternative="two_sided")
6560
cindex.compare(cindexB)
6661
```
6762

63+
---
64+
65+
## A collaborative project
66+
67+
This package was developed by **Novartis** and the **US Food and Drug Administration (FDA)** as part of a **research collaboration** agreement on [radiogenomics](https://www.medrxiv.org/content/10.1101/2023.08.30.23294367v1.full.pdf).
68+
69+
`TorchSurv` is now part of the **FDA’s [Regulatory Science Tool Catalog](https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis)** 🎉.
70+
71+
<details>
72+
<summary>Disclaimer Regarding the Catalog of Regulatory Science Tools</summary>
73+
74+
The enclosed tool is part of the [Catalog of Regulatory Science Tools](https://cdrh-rst.fda.gov/), which provides a peer-reviewed resource for stakeholders to use where standards and qualified Medical Device Development Tools (MDDTs) do not yet exist. These tools do not replace FDA-recognized standards or MDDTs. This catalog collates a variety of regulatory science tools that the FDA's Center for Devices and Radiological Health's (CDRH) Office of Science and Engineering Labs (OSEL) developed. These tools use the most innovative science to support medical device development and patient access to safe and effective medical devices. If you are considering using a tool from this catalog in your marketing submissions, note that these tools have not been qualified as [Medical Device Development Tools](https://www.fda.gov/medical-devices/medical-device-development-tools-mddt) and the FDA has not evaluated the suitability of these tools within any specific context of use. You may [request feedback or meetings for medical device submissions](https://www.fda.gov/regulatory-information/search-fda-guidance-documents/requests-feedback-and-meetings-medical-device-submissions-q-submission-program) as part of the Q-Submission Program.
75+
For more information about the Catalog of Regulatory Science Tools, email [[email protected]](mailto:[email protected]).
76+
77+
Tool Reference
78+
79+
* RST Reference Number: RST24AI17.01
80+
* Date of Publication: 10/16/2025
81+
* Recommended Citation: U.S. Food and Drug Administration. (2025). TorchSurv: Deep Learning Tools for Survival Analysis (RST24AI17.01). [https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis](https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis)
82+
83+
</details>
84+
85+
---
86+
6887
## Installation and dependencies
6988

7089
First, install the package using either [PyPI]([https://pypi.org/](https://pypi.org/project/torchsurv/)) or [Conda]([https://anaconda.org/anaconda/conda](https://anaconda.org/conda-forge/torchsurv))
7190

72-
- Using conda (**recommended**)
91+
- Using conda
7392
```bash
7493
conda install conda-forge::torchsurv
7594
```
@@ -214,7 +233,8 @@ We obtain the integrated brier-score with:
214233
tensor(0.4447)
215234
```
216235

217-
## Related Packages
236+
<details>
237+
<summary>Related packages</summary>
218238

219239
The table below compares the functionalities of `TorchSurv` with those of
220240
[auton-survival](https://proceedings.mlr.press/v182/nagpal22a.html),
@@ -235,15 +255,7 @@ weights (e.g., inverse probability of censoring weighting (IPCW)). Packages `sur
235255

236256
![Survival analysis libraries in R](/docs/source/table_r_benchmark.png)
237257

238-
## Disclaimer Regarding the Catalog of Regulatory Science Tools
239-
240-
The enclosed tool is part of the [Catalog of Regulatory Science Tools](https://cdrh-rst.fda.gov/), which provides a peer-reviewed resource for stakeholders to use where standards and qualified Medical Device Development Tools (MDDTs) do not yet exist. These tools do not replace FDA-recognized standards or MDDTs. This catalog collates a variety of regulatory science tools that the FDA's Center for Devices and Radiological Health's (CDRH) Office of Science and Engineering Labs (OSEL) developed. These tools use the most innovative science to support medical device development and patient access to safe and effective medical devices. If you are considering using a tool from this catalog in your marketing submissions, note that these tools have not been qualified as [Medical Device Development Tools](https://www.fda.gov/medical-devices/medical-device-development-tools-mddt) and the FDA has not evaluated the suitability of these tools within any specific context of use. You may [request feedback or meetings for medical device submissions](https://www.fda.gov/regulatory-information/search-fda-guidance-documents/requests-feedback-and-meetings-medical-device-submissions-q-submission-program) as part of the Q-Submission Program.
241-
For more information about the Catalog of Regulatory Science Tools, email [[email protected]](mailto:[email protected]).
242-
243-
Tool Reference
244-
* RST Reference Number: RST24AI17.01
245-
* Date of Publication: 10/16/2025
246-
* Recommended Citation: U.S. Food and Drug Administration. (2025). TorchSurv: Deep Learning Tools for Survival Analysis (RST24AI17.01). [https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis](https://cdrh-rst.fda.gov/torchsurv-deep-learning-tools-survival-analysis)
258+
</details>
247259

248260
## Contributing
249261

0 commit comments

Comments
 (0)