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
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ This repository is a self-contained [Copier](https://copier.readthedocs.io) temp
contract-first MEDS algorithm repositories.

Shared contracts and the canonical specification live in
[`meds-algorithm`](https://github.com/McDermottHealthAI/meds-algorithm). This development version pins the reviewed core revision
`69c994d5921521132b60a528aab86a2b1641d05a` for the upcoming `meds-algorithm==0.4.0a5` API.
Before publishing generator `0.4.0a2`, release core `0.4.0a5` and replace these Git requirements with
matching PyPI pins as described in the release guide.
[`meds-algorithm`](https://github.com/McDermottHealthAI/meds-algorithm). Generated repositories pin its PyPI release
`meds-algorithm==0.4.0a5` for reproducible installations.
The core owns the reusable infrastructure and conformance helpers; generated repositories import it directly.

The template fixes the external contract—MEDS input, six algorithm profiles and standard arguments, typed
Expand All @@ -39,15 +37,12 @@ uv run --group docs mkdocs serve

## Render a repository

To use the unreleased typed-API cleanup, render from this checkout as shown below. The currently
published generator `0.4.0a1` uses the previous core API.

The installable `meds-algorithm-template` command uses the matching `v<package-version>` tag from this
GitHub repository. It needs Git and network access; it does not bundle a second copy of the template.
For the currently published generator, use:
Install the pinned generator with:

```bash
uvx --from 'meds-algorithm-template==0.4.0a1' meds-algorithm-template ../my-meds-algorithm --trust
uvx --from 'meds-algorithm-template==0.4.0a2' meds-algorithm-template ../my-meds-algorithm --trust
```

Use `--defaults --data-file answers.yaml` for unattended generation. The answers file records the
Expand Down Expand Up @@ -410,5 +405,15 @@ repositories. Files under `template/` are the generated payload; root tests
validate that payload without imposing a algorithm implementation.

Profile selection and the distinct version 4 step names are described in [profiles](https://github.com/McDermottHealthAI/MEDS_algorithm_template/blob/main/docs/profiles.md).
See the [software contract](https://github.com/McDermottHealthAI/meds-algorithm/blob/69c994d5921521132b60a528aab86a2b1641d05a/src/meds_algorithm/CONTRACT.md), [migration guide](https://github.com/McDermottHealthAI/MEDS_algorithm_template/blob/main/docs/migration-v4.md),
See the [software contract](https://github.com/McDermottHealthAI/meds-algorithm/blob/v0.4.0a5/src/meds_algorithm/CONTRACT.md), [migration guide](https://github.com/McDermottHealthAI/MEDS_algorithm_template/blob/main/docs/migration-v4.md),
and [shared-package assessment](https://github.com/McDermottHealthAI/MEDS_algorithm_template/blob/main/docs/shared-package-assessment.md).

## Changes

### 0.4.0a2 (2026-11-03)

- Generate projects using the published `meds-algorithm==0.4.0a5` dependency.
- Inherit shared acceptance tests and keep algorithm-specific adapters and scientific tests local.
- Add the optional Hydra profile runner, local subprocess and Submitit execution, and resolved dry-run plans.
- Add the implementation prompt builder and reorganize documentation, including typed request UML and test guides.
- Use each algorithm's own executable name. Conformance and orchestration remain optional extras.
5 changes: 2 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ before GitHub exposes its manual dispatch action.

## 1. Switch generated projects to the published shared package

This development version pins core revision `99b3b59798d796360d1eff74fa75db58d35c4e90`.
First publish `meds-algorithm==0.4.0a5`, then replace the development Git requirements with the exact
PyPI requirements below before tagging generator `0.4.0a2`:
Generator `0.4.0a2` pins the published `meds-algorithm==0.4.0a5` release. For future updates,
release the shared package first, then keep all dependency pins and install examples aligned:

| File | Change |
|---|---|
Expand Down
2 changes: 1 addition & 1 deletion TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ builder uses plain JavaScript without runtime dependencies, network calls or per
single-profile and all-profile generation, compilation, canonical source URL and recorded release tag.
It detects packaging and version/source mistakes without requiring a real release tag to exist yet.

`scripts/check_release.py` requires matching exact PyPI pins for runtime, conformance and development
`scripts/check_release.py` requires matching exact PyPI pins for runtime, conformance, orchestration and development
uses of the shared package, then checks that the pinned version has downloadable files on PyPI. A Git
pin used to review unreleased core changes deliberately fails this release gate. Strict MkDocs checks
links/builds; Twine checks built distribution metadata. Neither proves scientific correctness.
Expand Down
4 changes: 2 additions & 2 deletions docs/core-package.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Shared core package

The core lives in its own [repository](https://github.com/McDermottHealthAI/meds-algorithm), pinned by the template to an immutable commit.
See its [layout and usage](https://github.com/McDermottHealthAI/meds-algorithm/blob/69c994d5921521132b60a528aab86a2b1641d05a/README.md) for its artifact, runtime, task, evaluation, integration and conformance APIs.
The core lives in its own [repository](https://github.com/McDermottHealthAI/meds-algorithm), pinned by the template to PyPI version `0.4.0a5`.
See its [layout and usage](https://github.com/McDermottHealthAI/meds-algorithm/blob/v0.4.0a5/README.md) for its artifact, runtime, task, evaluation, integration and conformance APIs.
The [specification](reference/spec.md) below is rendered from the installed dependency, so the site
and generated algorithms use the same version without copying the contract into this repository.
The [architecture and UML](reference/architecture.md) are also rendered from the pinned core wheel.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Documentation = "https://McDermottHealthAI.github.io/MEDS_algorithm_template/"
packages = ["src/meds_algorithm_template"]

[dependency-groups]
dev = ["meds-algorithm[conformance,orchestration] @ git+https://github.com/McDermottHealthAI/meds-algorithm.git@69c994d5921521132b60a528aab86a2b1641d05a", "polars>=1", "pyarrow>=15", "pytest>=8", "pyyaml>=6", "ruff"]
dev = ["meds-algorithm[conformance,orchestration]==0.4.0a5", "polars>=1", "pyarrow>=15", "pytest>=8", "pyyaml>=6", "ruff"]
# MkDocs 2.0 removes the plugin and theme systems Material depends on, so stay on 1.x.
docs = ["mkdocs>=1.6,<2", "mkdocs-material>=9.5,<10"]

Expand Down
9 changes: 3 additions & 6 deletions template/pyproject.toml.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,16 @@ name = "{{ algorithm_slug | replace('_', '-') }}"
version = "0.1.0"
description = "{{ algorithm_description }}"
requires-python = ">=3.11"
dependencies = ["pyyaml>=6", "meds-algorithm[data] @ git+https://github.com/McDermottHealthAI/meds-algorithm.git@69c994d5921521132b60a528aab86a2b1641d05a"]
dependencies = ["pyyaml>=6", "meds-algorithm[data]==0.4.0a5"]

[project.optional-dependencies]
orchestration = ["meds-algorithm[orchestration] @ git+https://github.com/McDermottHealthAI/meds-algorithm.git@69c994d5921521132b60a528aab86a2b1641d05a"]
orchestration = ["meds-algorithm[orchestration]==0.4.0a5"]
# meds-evaluation is pinned to the version MEDS-DEV evaluates predictions with.
test = ["meds-algorithm[conformance] @ git+https://github.com/McDermottHealthAI/meds-algorithm.git@69c994d5921521132b60a528aab86a2b1641d05a"]
test = ["meds-algorithm[conformance]==0.4.0a5"]

[project.scripts]
{{ algorithm_slug | replace('_', '-') }} = "{{ algorithm_slug }}.__main__:main"

[tool.hatch.metadata]
allow-direct-references = true

[tool.hatch.build.targets.wheel]
packages = ["src/{{ algorithm_slug }}"]

Expand Down
8 changes: 6 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading