otx.cli.install#

OTX CLI Installation.

Functions

add_install_parser(subcommands_action)

Add subparser for install command.

otx_install([option, verbose, ...])

Install OTX requirements.

otx.cli.install.add_install_parser(subcommands_action: _ActionSubCommands) None[source]#

Add subparser for install command.

Parameters:

subcommands_action (_ActionSubCommands) – Sub-Command in CLI.

Returns:

None

otx.cli.install.otx_install(option: str | None = None, verbose: bool = False, do_not_install_torch: bool = False, user: bool = False) int[source]#

Install OTX requirements.

Parameters:
  • option (str) – Optional-dependency to install requirements for.

  • verbose (bool) – Set pip logger level to INFO

  • do_not_install_torch (bool) – If true, skip PyTorch installation.

  • user (bool) – If true, install packages in the user site directory, e.g., pip install –user …

Raises:

ValueError – When the task is not supported.

Returns:

Status code of the pip install command.

Return type:

int