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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,8 @@ and [shared-package assessment](https://github.com/McDermottHealthAI/MEDS_algori

### Unreleased

- Link to the shared `meds-algorithm` catalogue and explain registration in generated release guides.

- Generate an algorithm release guide, Trusted Publishing workflow, and installed-distribution checks.
- Configure PyPI metadata separately from Python names and bundle portable run/profile YAMLs once at build time.

Expand Down
14 changes: 14 additions & 0 deletions docs/implemented-algorithms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Implemented algorithms

The [algorithm catalogue](https://mcdermotthealthai.github.io/meds-algorithm/implemented-algorithms/)
is maintained in `meds-algorithm`, the shared ecosystem repository. It includes implementation status,
declared profiles, validation evidence and reviewed PyPI installation commands.

To register an implementation or update its reviewed version, open a PR editing
[`catalogue/algorithms.yaml`](https://github.com/McDermottHealthAI/meds-algorithm/blob/main/catalogue/algorithms.yaml)
there. The [catalogue guide](https://mcdermotthealthai.github.io/meds-algorithm/implemented-algorithms/#register-or-update-an-algorithm)
explains evidence requirements, private listings and automated release observations.

The template provides generation, implementation and publishing instructions; it does not keep a second
registry or update workflow. See [publishing an algorithm](publishing-algorithms.md) for preparing a release
before registering its PyPI version.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ nav:
- Overview: index.md
- Concepts: concepts.md
- Choosing a profile: profiles.md
- Implemented algorithms: implemented-algorithms.md
- Workflow: workflow.md
- Building an algorithm:
- Implementation prompt builder: prompt-builder.md
Expand Down
13 changes: 13 additions & 0 deletions template/RELEASING.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,19 @@ files using Trusted Publishing. Rehearsal and production runs each build and che
from the same tag. After success, install `{{ package_name }}==$version` in a fresh environment and
repeat the smoke check. Never move a published tag or reuse a published version; increment it for fixes.

## Registering your algorithm

After publication, register the package in the shared ecosystem's
[algorithm catalogue](https://mcdermotthealthai.github.io/meds-algorithm/implemented-algorithms/).
Open a PR against `catalogue/algorithms.yaml` in `McDermottHealthAI/meds-algorithm`
with the PyPI name `{{ package_name }}`, exact published
version, immutable implementation commit, declared profiles and links to validation evidence. The site
generates the installation command from that reviewed pin. An implementation under review can be listed
earlier with `pypi_version: null`; do not advertise an install command for an unpublished name.
For a private repository, authorize only metadata intended for public listing and mark access private.
Update the entry when a new release has been reviewed; automated release discovery does not establish
scientific validation. Keep dataset contents and private run details out of the public catalogue.

## What installation includes

`configs/runs/` and `algorithms/` are the single editable source for portable run defaults and MEDS-DEV
Expand Down
Loading