diff --git a/README.md b/README.md index 313793b..12313b5 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/implemented-algorithms.md b/docs/implemented-algorithms.md new file mode 100644 index 0000000..03fe1a2 --- /dev/null +++ b/docs/implemented-algorithms.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 664581e..442259c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/template/RELEASING.md.jinja b/template/RELEASING.md.jinja index 4928db8..9c24cd6 100644 --- a/template/RELEASING.md.jinja +++ b/template/RELEASING.md.jinja @@ -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