Finter Cli Submission

Streamline Your Finter Model Submission

The Finter CLI submission feature was added in version v0.2.185. It is recommended to use this feature when submitting with the latest version of Finter.

Description

You can submit your model using the finter CLI. When the command is executed from your working directory, the entire folder will be submitted. Therefore, it is important to ensure that there are no unnecessary files or folders in your working directory.

The finter CLI assumes that your working directory follows the structure outlined below.

working_directory
 ├── [am.py or pm.py or ffd.py]
 ├── Dockerfile
 ├── model_meta.json (automatically generated by cli)
 ├── pyproject.toml
 ├── poetry.lock  
 ├── other files or folders for model (e.g. ckpt file, python module)

The folder name of the working directory is used as model_alias.

In the working_directory, exactly one of am.py, pm.py, or ffd.py must exist, and model_type is determined as one of alpha, portfolio, or flexible_fund.

Synopsis

finter submit
--universe [kr_stock|us_etf|us_stock|vn_stock|vn_stock_deprecated|id_stock|crypto_spot_binance]
[--gpu]
[--image-tag [2.1.0-gpu]]
[--machine [g4dn.2xlarge]]
[--poetry-path <value>]
[--custom-docker-file]
[--start <value>]
[--ignore-local-validation]
[--staging]

Options

universe (string): The name of the universe.

• kr_stock

• us_etf

• us_stock

• vn_stock

• vn_stock_deprecated

• id_stock

• crypto_spot_binance

gpu (boolean | optional): Whether to use GPU machine.

image-tag (string | optional): Choose the SageMaker image tag (only applicable if GPU is true).

Github

• 2.1.0-gpu: public.ecr.aws/sagemaker/sagemaker-distribution:2.1.0-gpu

machine (string | optional): Choose the machine type (only applicable if GPU is true).

• g4dn.2xlarge

poetry-path (string | optional): Path to the directory containing the Poetry pyproject.toml and poetry.lock files to be copied to the current working directory (Optional). This option is not needed if these files already exist in the current workspace. If submitting for GPU tasks, specify only the additional packages required for the SageMaker image. If not provided and a Poetry file exists in the home directory, it will be automatically copied.

custom-docker-file (boolean | optional): Whether to use custom docker file. If not provided, an appropriate Dockerfile will be generated.

start (int | optional): Start date for submission in YYYYMMDD format. If not provided, the system will automatically calculate the start date during submission.

ignore-local-validation (boolean | optional): Skip validation tests in the environment where Finter is executed.

staging (boolean | optional): Whether to use staging environment