Skip to content
This repository was archived by the owner on Jul 14, 2025. It is now read-only.

Commit 378b15c

Browse files
committed
Add checkpoint role and fix runtime volume variables
1 parent 15adc8b commit 378b15c

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ for a given [Learning Approach](#ml-modellearning_approach).
109109
| -------------------------- | ----------- |
110110
| ml-model:inference-runtime | Represents a file containing instructions for running a containerized version of the model to generate inferences. See the [Inference/Training Runtimes](#inferencetraining-runtimes) section below for details on related fields. |
111111
| ml-model:training-runtime | Represents a file containing instructions for running a container to train the model. See the [Inference/Training Runtimes](#inferencetraining-runtimes) section below for details on related fields. |
112+
| ml-model:checkpoint | Represents a PyTorch checkpoint file that can used to load the model (see [official PyTorch documentation for details](https://pytorch.org/tutorials/beginner/saving_loading_models.html)) |
112113

113114
### Inference/Training Runtimes
114115

@@ -124,7 +125,7 @@ While the Compose file defines nearly all of the parameters required to run the
124125
directory containing input data should be mounted to the container and to which host directory the output predictions should be written. The Compose
125126
file MUST define volume mounts for input and output data using the Compose
126127
[Interpolation syntax](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). The input data volume MUST be defined by an
127-
`INPUT_VOLUME` variable and the output data volume MUST be defined by an `OUTPUT_DATA` variable.
128+
`INPUT_DATA` variable and the output data volume MUST be defined by an `OUTPUT_DATA` variable.
128129

129130
For example, the following Compose file snippet would mount the host input directory to `/var/data/input` in the container and would mount the host
130131
output data directory to `/var/data/output` in the host container. In this contrived example, the script to run the model takes 2 arguments: the

examples/dummy/inferencing.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ services:
22
model-inference:
33
image: registry.hub.docker.com/my-user/my-inferencing-model:v1
44
volumes:
5-
- "${INPUT_VOLUME}:/var/data/input"
6-
- "${OUTPUT_VOLUME}:/var/data/output"
5+
- "${INPUT_DATA}:/var/data/input"
6+
- "${OUTPUT_DATA}:/var/data/output"
77
entrypoint: bash /app/scripts/run-model.sh
88

0 commit comments

Comments
 (0)