{"type":"doc","content":[{"type":"paragraph","content":[{"text":"ModelOp Center provides a CLI-based “test utility” to allow users to test their model within a ModelOp Runtime without officially registering the model with ModelOp Center. This is particularly useful if there is complex code in your model, custom integrations or data pipelines, or custom dependencies that need to be tested for compatibility. ","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9e0bcc3b-a6df-416e-a358-fefc18ca58d1"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"1ca5a2d0-2bf0-48c4-96a3-7bc9cc8c2706"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"ModelOp CLI provides runtime test utility under ","type":"text"},{"text":"iterative","type":"text","marks":[{"type":"code"}]},{"text":" command. The utility provides users to provide a way to test the model code along with the assets using local files on the ModelOp runtime. ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"CLI Installation","type":"text"}]},{"type":"paragraph","content":[{"text":"Please follow the steps mentioned here to download and set up the ModelOp CLI : ","type":"text"},{"text":"Install CLI","type":"text","marks":[{"type":"link","attrs":{"href":"https://modelopdocs.atlassian.net/wiki/spaces/dv33/pages/1978442332"}}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Interacting directly with a runtime in 'secured' mode via the ","type":"text"},{"text":"iterative","type":"text","marks":[{"type":"code"}]},{"text":" command requires admin credentials.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Overview of commands","type":"text"}]},{"type":"paragraph","content":[{"text":"The help for the moc commands is presented in Linux man page format.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type ","type":"text"},{"text":"help ","type":"text","marks":[{"type":"code"}]},{"text":"to get general information about command-line man pages.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Type ","type":"text"},{"text":"help ","type":"text","marks":[{"type":"code"}]},{"text":" to get information about a specific command.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The following moc commands are available under ","type":"text"},{"text":"iterative","type":"text","marks":[{"type":"code"}]},{"text":" command:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iterative","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"engine","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"job","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"logs","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"model","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Command details","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"iterative","type":"text"}]},{"type":"paragraph","content":[{"text":"Synopsis","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative [--help | --version]\nmoc iterative ","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"User ","type":"text"},{"text":"moc iterative","type":"text","marks":[{"type":"code"}]},{"text":" command to test model source code and assets on ModelOp Runtime. ","type":"text"},{"text":"moc iterative","type":"text","marks":[{"type":"code"}]},{"text":" has sub-commands to run different types of jobs and deploy the model as REST. Before using any commands, the CLI needs to know which engine to use for the commands. To set the target engine for the command please see the ","type":"text"},{"text":"engine use","type":"text","marks":[{"type":"link","attrs":{"href":"https://modelopdocs.atlassian.net/wiki/spaces/dv33/pages/1978442361/ModelOp+Runtime+Test+Utility#use"}}]},{"text":" command. Description for the sub-commands is as shown below.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"engine","type":"text"}]},{"type":"paragraph","content":[{"text":"Synopsis","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative engine [--help]\nmoc iterative engine [--help]\nmoc iterative engine reset [--help]\nmoc iterative engine score [--help]\nmoc iterative engine status [--help]\nmoc iterative engine use [flags]","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"moc iterative engine","type":"text","marks":[{"type":"code"}]},{"text":" commands to interact with the ModelOp runtime. It has the following sub-commands that can be used:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"reset","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this command to reset the target runtime set using the ","type":"text"},{"text":"moc iterative engine use","type":"text","marks":[{"type":"code"}]},{"text":" command. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any options","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative engine reset","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"score","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this command to send records for scoring to the target runtime set using the ","type":"text"},{"text":"moc iterative engine use","type":"text","marks":[{"type":"code"}]},{"text":" command.","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"--input","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Specify a file to use as the source of the input records. When not set, input records are read from ","type":"text"},{"text":"stdin","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative engine score --input input.json\nmoc iterative engine score < input.json\necho '\"my-input-string\"' | moc iterative engine score","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"status","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this command to know the status of the target runtime set using the ","type":"text"},{"text":"moc iterative engine use","type":"text","marks":[{"type":"code"}]},{"text":" command. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any options","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative engine status","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"use","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use this command to set the target ModelOp runtime. All the commands under the ","type":"text"},{"text":"moc iterative","type":"text","marks":[{"type":"code"}]},{"text":" commands are run using the runtime set during this time. Set the target runtime using a URL pointing to ModelOp runtime engine or the name of a known engine set up using the ","type":"text"},{"text":"moc init","type":"text","marks":[{"type":"code"}]},{"text":" command. If the engine is behind a secured gateway, use ","type":"text"},{"text":"--token","type":"text","marks":[{"type":"code"}]},{"text":" flag to provide a JWT token that can be used for the authentication.","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"--token","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"JWT token for authentication (If runtime is behind secured gateway)","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"engine URL | name","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Either a URL pointing to ModelOp Runtime or the name of a known runtime (set via ","type":"text"},{"text":"moc init","type":"text","marks":[{"type":"code"}]},{"text":")","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"# Use a local runtime on port 8093 on an unsecured instance\nmoc iterative engine use http://localhost:8093\n\n# Use a local runtime on port 8093 using an OAuth token for a secured instance\nmoc iterative engine use http://localhost:8093 --token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ\n\n# Use a runtime in a known instance (set up using the \"moc init\" command)\nmoc iterative engine use engine-3","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"job","type":"text"}]},{"type":"paragraph","content":[{"text":"Synopsis","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative job [--help]\nmoc iterative job [--help]\nmoc iterative job create < [additional model files]... <--input file> <--output file> [--schema-in] [--schema-out] [--help]","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"moc iterative job","type":"text","marks":[{"type":"code"}]},{"text":" commands to create and run different jobs on ModelOp runtime. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"create","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Run different types of jobs on ModelOp runtime. The command allows the creation of 3 types of jobs: batch job, test job (metrics job), and training jobs. The options and arguments are shared between commands to run these 3 types of jobs. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The command requires the path to the primary source code as the FIRST argument. The primary source code file should have a tagged function depending on the type of job to run. (","type":"text"},{"text":"# modelop.score","type":"text","marks":[{"type":"code"}]},{"text":" for batch job, ","type":"text"},{"text":"# modelop.train","type":"text","marks":[{"type":"code"}]},{"text":" for training job and ","type":"text"},{"text":"# modelop.metrics","type":"text","marks":[{"type":"code"}]},{"text":" for test job). Additional assets required by the model (additional source code files, model-binary, etc.) can be provided with the subsequent arguments. Optionally, a path to the directory can be provided in addition to the path for the primary source code file. The CLI will process each file in that directory recursively and add assets to the model during which any duplicate files will be ignored (matching the same path and filename).","type":"text"}]},{"type":"paragraph","content":[{"text":"NOTE: make sure to structure source code files in the same way required by the model as ModelOp runtime needs the relative path of the additional source code files to the primary source code file.","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"If the model schemas were not part of the directory, schemas can be provided by using --schema-in and --schema-out flags.","type":"text"}]},{"type":"paragraph","content":[{"text":"The input file(s) to the job can be provided using the --input flag and the Output file(s) can be provided using the --output flag. The output file is not required to be created beforehand. If the output file already exists, the output of the job will be written to that file. Otherwise, a new file will be created at the given path and the results will be stored in the newly created file.","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"--input","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide input for the job. The flag can be used multiple times to provide multiple input files.","type":"text"}]},{"type":"paragraph","content":[{"text":"--logs","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Print logs for the job","type":"text"}]},{"type":"paragraph","content":[{"text":"--output","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Specify output location for the job. The flag can be used multiple times to provide multiple output file locations.","type":"text"}]},{"type":"paragraph","content":[{"text":"--schema-in","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide input schema for the model. The flag can be used multiple times to provide multiple schemas.","type":"text"}]},{"type":"paragraph","content":[{"text":"--schema-out","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide output schema for the model. The flag can be used multiple times to provide multiple schemas.","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"batchjob","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Create a model batch scoring job (MODEL_BATCH_JOB)","type":"text"}]},{"type":"paragraph","content":[{"text":"testjob","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Create a model batch metrics job (MODEL_BATCH_TEST_JOB)","type":"text"}]},{"type":"paragraph","content":[{"text":"trainingjob","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Create a model training job (MODEL_BATCH_TRAINING_JOB)","type":"text"}]},{"type":"paragraph","content":[{"text":"primary sourcecode","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide the path to the primary source code file","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative job create batchjob ./model/echo.py --input ./model/input.json --output ./model/op.json\nmoc iterative job create batchjob ./model/echo.py ./model_folder --input ./model/input.json --output ./model/op.json\nmoc iterative job create batchjob ./model/echo.py ./model_folder --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json\nmoc iterative job create batchjob ./model/echo.py ./model/helper.py --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json\n\nmoc iterative job create testjob ./model/echo.py --input ./model/input.json --output ./model/op.json\nmoc iterative job create testjob ./model/echo.py ./model_folder --input ./model/input.json --output ./model/op.json\nmoc iterative job create testjob ./model/echo.py ./model_folder --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json\nmoc iterative job create testjob ./model/echo.py ./model/helper.py --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json\n\nmoc iterative job create trainingjob ./model/echo.py --input ./model/input.json --output ./model/op.json\nmoc iterative job create trainingjob ./model/echo.py ./model_folder --input ./model/input.json --output ./model/op.json\nmoc iterative job create trainingjob ./model/echo.py ./model_folder --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json\nmoc iterative job create trainingjob ./model/echo.py ./model/helper.py --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc --input ./model/input.json --output ./model/op.json","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"logs","type":"text"}]},{"type":"paragraph","content":[{"text":"Synopsis","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative logs [--help]","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Print logs for the target runtime. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"-f, --follow","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Specify if the logs should be streamed","type":"text"}]},{"type":"paragraph","content":[{"text":"-t, --tail","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Lines of the recent log file to display. (default 100)","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The command does not take any arguments","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative logs","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"model","type":"text"}]},{"type":"paragraph","content":[{"text":"Synopsis","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative model [--help]\nmoc iterative model deploy [--help]","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use the command to deploy the model to ModelOp runtime as REST.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"deploy","type":"text"}]},{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Create and deploy a model in ModelOp runtime as REST. The command requires the path to the primary source code as the FIRST argument. The primary source code file should have a tagged function depending on the type of job to run. (","type":"text"},{"text":"# modelop.score","type":"text","marks":[{"type":"code"}]},{"text":" for batch job, ","type":"text"},{"text":"# modelop.train","type":"text","marks":[{"type":"code"}]},{"text":" for training job and ","type":"text"},{"text":"# modelop.metrics","type":"text","marks":[{"type":"code"}]},{"text":" for test job). Additional assets required by the model (additional source code files, model-binary, etc.) can be provided with the subsequent arguments. Optionally, a path to the directory can be provided in addition to the path for the primary source code file. The CLI will process each file in that directory recursively and add assets to the model during which any duplicate files will be ignored (matching the same path and filename).","type":"text"},{"type":"hardBreak"},{"text":"NOTE: make sure to structure source code files in the same way required by the model as ModelOp runtime needs the relative path of the additional source code files to the primary source code file.","type":"text","marks":[{"type":"underline"}]}]},{"type":"paragraph","content":[{"text":"If the model schemas were not part of the directory, schemas can be provided by using --schema-in and --schema-out flags.","type":"text"}]},{"type":"paragraph","content":[{"text":"Options","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"--schema-in","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide input schema for the model. The flag can be used multiple times to provide multiple schemas.","type":"text"}]},{"type":"paragraph","content":[{"text":"--schema-out","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide output schema for the model. The flag can be used multiple times to provide multiple schemas.","type":"text"}]},{"type":"paragraph","content":[{"text":"Arguments","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"primary sourcecode","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Provide the path to the primary source code file","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"moc iterative model deploy ./model/echo.py\nmoc iterative model deploy ./model/echo.py ./model\nmoc iterative model deploy ./model/echo.py ./model --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc\nmoc iterative model deploy ./model/echo.py ./model/helper.py --schema-in ./common/input_schema.avsc --schema-out ./common/output_schema.avsc","type":"text"}]}],"version":1}

Browser not supported