Skip to content

run-docker-container

Automatically generated README for this automation recipe: run-docker-container

Category: Docker automation

License: Apache 2.0

  • Notes from the authors, contributors and users: README-extra

  • CM meta description for this script: _cm.yaml

  • Output cached? False

Reuse this script in your project

Install MLCommons CM automation meta-framework

Pull CM repository with this automation recipe (CM script)

cm pull repo mlcommons@cm4mlops

cmr "run docker container" --help

Run this script

Run this script via CLI
cm run script --tags=run,docker,container [--input_flags]
Run this script via CLI (alternative)
cmr "run docker container " [--input_flags]
Run this script from Python
import cmind

r = cmind.access({'action':'run'
              'automation':'script',
              'tags':'run,docker,container'
              'out':'con',
              ...
              (other input keys for this script)
              ...
             })

if r['return']>0:
    print (r['error'])
Run this script via Docker (beta)
cm docker script "run docker container" [--input_flags]

Script flags mapped to environment

  • --all_gpus=value → CM_DOCKER_ADD_ALL_GPUS=value
  • --base=value → CM_DOCKER_IMAGE_BASE=value
  • --cache=value → CM_DOCKER_CACHE=value
  • --cm_repo=value → CM_MLOPS_REPO=value
  • --detached=value → CM_DOCKER_DETACHED_MODE=value
  • --device=value → CM_DOCKER_ADD_DEVICE=value
  • --docker_image_base=value → CM_DOCKER_IMAGE_BASE=value
  • --docker_os=value → CM_DOCKER_OS=value
  • --docker_os_version=value → CM_DOCKER_OS_VERSION=value
  • --extra_run_args=value → CM_DOCKER_EXTRA_RUN_ARGS=value
  • --fake_run_option=value → CM_DOCKER_FAKE_RUN_OPTION=value
  • --gh_token=value → CM_GH_TOKEN=value
  • --image_name=value → CM_DOCKER_IMAGE_NAME=value
  • --image_repo=value → CM_DOCKER_IMAGE_REPO=value
  • --image_tag=value → CM_DOCKER_IMAGE_TAG=value
  • --image_tag_extra=value → CM_DOCKER_IMAGE_TAG_EXTRA=value
  • --interactive=value → CM_DOCKER_INTERACTIVE_MODE=value
  • --it=value → CM_DOCKER_INTERACTIVE=value
  • --mounts=value → CM_DOCKER_VOLUME_MOUNTS=value
  • --num_gpus=value → CM_DOCKER_ADD_NUM_GPUS=value
  • --pass_user_group=value → CM_DOCKER_PASS_USER_GROUP=value
  • --port_maps=value → CM_DOCKER_PORT_MAPS=value
  • --post_run_cmds=value → CM_DOCKER_POST_RUN_COMMANDS=value
  • --pre_run_cmds=value → CM_DOCKER_PRE_RUN_COMMANDS=value
  • --real_run=value → CM_REAL_RUN=value
  • --recreate=value → CM_DOCKER_IMAGE_RECREATE=value
  • --run_cmd=value → CM_DOCKER_RUN_CMD=value
  • --run_cmd_extra=value → CM_DOCKER_RUN_CMD_EXTRA=value
  • --save_script=value → CM_DOCKER_SAVE_SCRIPT=value
  • --script_tags=value → CM_DOCKER_RUN_SCRIPT_TAGS=value
  • --shm_size=value → CM_DOCKER_SHM_SIZE=value

Default environment

These keys can be updated via --env.KEY=VALUE or env dictionary in @input.json or using script flags.

  • CM_DOCKER_DETACHED_MODE: yes

Script output

cmr "run docker container " [--input_flags] -j