runtime

Runtime functions

TIP

Note that the documentation is automatically generated from envd/api folder in tensorchord/envd repo. Please update the python file there instead of directly editing file inside envd-docs repo.

WARNING

v0 syntax is no longer supported from envd>=v1.0. Check the upgrade guide.

If you want to use v0 syntax, try pip install 'envd<1'.

command

def command(commands: Dict[str, str])

Execute commands during runtime

Arguments:

• commands Dict[str, str] - map name to command, similar to Makefile

  Example usage:

runtime.command(commands={
    "train": "python train.py --epoch 20 --notify me@tensorchord.ai",
    "run": "python server.py --batch 1 --host 0.0.0.0 --port 8000",
})

You can run envd exec --command train to train the model.

expose

def expose(envd_port: int, host_port: Optional[int], service: Optional[str],
           listen_addr: Optional[str])

Expose port to host Proposal: https://github.com/tensorchord/envd/pull/780

Arguments:

• envd_port int - port in envd container
• host_port Optional[int] - port in the host, if not provided or host_port=0, envd will randomly choose a free port
• service Optional[str] - service name
• listen_addr Optional[str] - address to listen on

daemon

def daemon(commands: List[List[str]])

Run daemon processes in the container Proposal: https://github.com/tensorchord/envd/pull/769

It's better to redirect the logs to local files for debugging purposes.

You can find the generated horust config files under /etc/horust/services and log files under /var/log/horust in the container.

Arguments:

• commands List[List[str]] - run multiple commands in the background

  Example usage:

runtime.daemon(commands=[
    ["jupyter-lab", "--port", "8080"],
    ["python3", "serving.py", ">>serving.log", "2>&1"],
])

environ

def environ(env: Dict[str, str], extra_path: List[str])

Add runtime environments

Arguments:

• env Dict[str, str] - environment name to value

• extra_path List[str] - additional PATH

  Example usage:

runtime.environ(env={"ENVD_MODE": "DEV"}, extra_path=["/usr/bin/go/bin"])

mount

def mount(host_path: str, envd_path: str)

Mount from host path to container path (runtime)

Arguments:

• host_path str - source path in the host machine
• envd_path str - destination path in the envd container

init

def init(commands: List[str])

Commands to be executed when start the container

You can find the generated horust config files under /etc/horust/services and log files under /var/log/horust in the container.

Arguments:

• commands List[str] - list of commands