oci-cli 3.62.2__py3-none-any.whl → 3.63.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/data-science/model-deployment/create-model-deployment-model-group-deployment-configuration-details.txt

@@ -0,0 +1,215 @@
+"create-model-deployment-model-group-deployment-configuration-details"
+**********************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a new model deployment.
+
+
+Usage
+=====
+
+   oci data-science model-deployment create-model-deployment-model-group-deployment-configuration-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment where you want to create the model
+deployment.
+
+--model-deployment-configuration-details-infrastructure-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--model-deployment-configuration-details-model-group-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--project-id [text]
+
+The OCID of the project to associate with the model deployment.
+
+
+Optional Parameters
+===================
+
+--category-log-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. See Resource Tags. Example: *{“Operations”: {“CostCenter”:
+“42”}}* This is a complex type whose value must be valid JSON. The
+value can be provided as a string on the command line or passed in as
+a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--description [text]
+
+A short description of the model deployment.
+
+--display-name [text]
+
+A user-friendly display name for the resource. Does not have to be
+unique, and can be modified. Avoid entering confidential information.
+Example: *My ModelDeployment*
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. See Resource Tags.
+Example: *{“Department”: “Finance”}* This is a complex type whose
+value must be valid JSON. The value can be provided as a string on the
+command line or passed in as a file using the file://path/to/file
+syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--model-deployment-configuration-details-environment-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--opc-parent-rpt-url [text]
+
+URL to fetch the Resource Principal Token from the parent resource.
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain state. Multiple states can be specified,
+returning on the first state. For example, "--wait-for-state"
+SUCCEEDED "--wait-for-state" FAILED would return on whichever
+lifecycle state is reached first. If timeout is reached, a return code
+of 2 is returned. For any other error, a return code of 1 is returned.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the state defined by "--wait-for-state". Defaults to 30
+seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci data-science model-deployment create-model-deployment-model-group-deployment-configuration-details --generate-param-json-input model-deployment-configuration-details-infrastructure-configuration-details > model-deployment-configuration-details-infrastructure-configuration-details.json
+       oci data-science model-deployment create-model-deployment-model-group-deployment-configuration-details --generate-param-json-input model-deployment-configuration-details-model-group-configuration-details > model-deployment-configuration-details-model-group-configuration-details.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/project/create.html#cmdoption-compartment-id
+
+       project_id=$(oci data-science project create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-science model-deployment create-model-deployment-model-group-deployment-configuration-details --compartment-id $compartment_id --model-deployment-configuration-details-infrastructure-configuration-details file://model-deployment-configuration-details-infrastructure-configuration-details.json --model-deployment-configuration-details-model-group-configuration-details file://model-deployment-configuration-details-model-group-configuration-details.json --project-id $project_id

oci_cli/help_text_producer/data_files/text/cmdref/data-science/model-deployment/update-model-deployment-update-model-group-deployment-configuration-details.txt

@@ -0,0 +1,235 @@
+"update-model-deployment-update-model-group-deployment-configuration-details"
+*****************************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the properties of a model deployment. Some of the properties
+of *modelDeploymentConfigurationDetails* or *CategoryLogDetails* can
+also be updated with zero down time when the model deployment’s
+lifecycle state is ACTIVE or NEEDS_ATTENTION i.e *instanceShapeName*,
+*instanceCount* and *modelId*, separately *loadBalancerShape* or
+*CategoryLogDetails* can also be updated independently. All of the
+fields can be updated when the deployment is in the INACTIVE lifecycle
+state. Changes will take effect the next time the model deployment is
+activated.
+
+
+Usage
+=====
+
+   oci data-science model-deployment update-model-deployment-update-model-group-deployment-configuration-details [OPTIONS]
+
+
+Required Parameters
+===================
+
+--model-deployment-id [text]
+
+The OCID of the model deployment.
+
+
+Optional Parameters
+===================
+
+--category-log-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. See Resource Tags. Example: *{“Operations”: {“CostCenter”:
+“42”}}* This is a complex type whose value must be valid JSON. The
+value can be provided as a string on the command line or passed in as
+a file using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--description [text]
+
+A short description of the model deployment.
+
+--display-name [text]
+
+A user-friendly display name for the resource. Does not have to be
+unique, and can be modified. Avoid entering confidential information.
+Example: *My ModelDeployment*
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Free-form tags for this resource. Each tag is a simple key-value pair
+with no predefined name, type, or namespace. See Resource Tags.
+Example: *{“Department”: “Finance”}* This is a complex type whose
+value must be valid JSON. The value can be provided as a string on the
+command line or passed in as a file using the file://path/to/file
+syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--if-match [text]
+
+For optimistic concurrency control. In the PUT or DELETE call for a
+resource, set the *if-match* parameter to the value of the etag from a
+previous GET or POST response for that resource. The resource is
+updated or deleted only if the *etag* you provide matches the
+resource’s current *etag* value.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the work request to reach the state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--model-deployment-configuration-details-environment-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--model-deployment-configuration-details-infrastructure-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--model-deployment-configuration-details-model-group-configuration-details [complex type]
+
+This is a complex type whose value must be valid JSON. The value can
+be provided as a string on the command line or passed in as a file
+using the file://path/to/file syntax.
+
+The "--generate-param-json-input" option can be used to generate an
+example of the JSON which must be provided. We recommend storing this
+example in a file, modifying it as needed and then passing it back in
+via the file:// syntax.
+
+--model-deployment-configuration-details-update-type [text]
+
+The type of update operation.
+
+Accepted values are:
+
+   LIVE, ZDT
+
+--wait-for-state [text]
+
+This operation asynchronously creates, modifies or deletes a resource
+and uses a work request to track the progress of the operation.
+Specify this option to perform the action and then wait until the work
+request reaches a certain state. Multiple states can be specified,
+returning on the first state. For example, "--wait-for-state"
+SUCCEEDED "--wait-for-state" FAILED would return on whichever
+lifecycle state is reached first. If timeout is reached, a return code
+of 2 is returned. For any other error, a return code of 1 is returned.
+
+Accepted values are:
+
+   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the work request
+has reached the state defined by "--wait-for-state". Defaults to 30
+seconds.
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci data-science model-deployment create --generate-param-json-input model-deployment-configuration-details > model-deployment-configuration-details.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/project/create.html#cmdoption-compartment-id
+
+       project_id=$(oci data-science project create --compartment-id $compartment_id --query data.id --raw-output)
+
+       model_deployment_id=$(oci data-science model-deployment create --compartment-id $compartment_id --model-deployment-configuration-details file://model-deployment-configuration-details.json --project-id $project_id --query data.id --raw-output)
+
+       oci data-science model-deployment update-model-deployment-update-model-group-deployment-configuration-details --model-deployment-id $model_deployment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-science/model-deployment-model-state/list.txt

@@ -0,0 +1,167 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists the status of models in a model group deployment.
+
+
+Usage
+=====
+
+   oci data-science model-deployment-model-state list [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+<b>Filter</b> results by the OCID of the compartment.
+
+--model-deployment-id [text]
+
+The OCID of the model deployment.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--display-name [text]
+
+<b>Filter</b> results by its user-friendly name.
+
+--from-json [text]
+
+Provide input to this command as a JSON document from a file using the
+file://path-to/file syntax.
+
+The "--generate-full-command-json-input" option can be used to
+generate a sample json file to be used with this command option. The
+key names are pre-populated and match the command option names
+(converted to camelCase format, e.g. compartment-id –> compartmentId),
+while the values of the keys need to be populated by the user before
+using the sample file as an input to this command. For any command
+option that accepts multiple values, the value of the key can be a
+JSON array.
+
+Options can still be provided on the command line. If an option exists
+in both the JSON document and the command line then the command line
+specified value will be used.
+
+For examples on usage of this option, please see our “using CLI with
+advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
+nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
+
+--inference-key [text]
+
+<b>Filter</b> results by the inference key.
+
+--limit [integer]
+
+For list pagination. The maximum number of results per page, or items
+to return in a paginated “List” call. 1 is the minimum, 100 is the
+maximum. See List Pagination.
+
+Example:
+
+   50
+
+--model-id [text]
+
+<b>Filter</b> results by the model ocid.
+
+--page [text]
+
+For list pagination. The value of the *opc-next-page* response header
+from the previous “List” call.
+
+See List Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--project-id [text]
+
+<b>Filter</b> results by the OCID of the project.
+
+--sort-by [text]
+
+Specifies the field to sort by. Accepts only one field. By default,
+when you sort by *timeCreated*, results are shown in descending order.
+When you sort by *displayName*, results are shown in ascending order.
+Sort order for the *displayName* field is case sensitive.
+
+Accepted values are:
+
+   displayName, timeCreated
+
+--sort-order [text]
+
+Specifies sort order to use, either *ASC* (ascending) or *DESC*
+(descending).
+
+Accepted values are:
+
+   ASC, DESC
+
+
+Global Parameters
+=================
+
+Use "oci --help" for help on global parameters.
+
+"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
+cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
+defaults-file", "--endpoint", "--generate-full-command-json-input", "
+--generate-param-json-input", "--help", "--latest-version", "--max-
+retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
+"--output", "--profile", "--proxy", "--query", "--raw-output", "--
+read-timeout", "--realm-specific-endpoint", "--region", "--release-
+info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"
+
+
+Example using required parameter
+================================
+
+Copy and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci data-science model-deployment create --generate-param-json-input model-deployment-configuration-details > model-deployment-configuration-details.json
+
+Copy the following CLI commands into a file named example.sh. Run the
+command by typing “bash example.sh” and replacing the example
+parameters with your own.
+
+Please note this sample will only work in the POSIX-compliant bash-
+like shell. You need to set up the OCI configuration and appropriate
+security policies before trying the examples.
+
+       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/project/create.html#cmdoption-compartment-id
+
+       project_id=$(oci data-science project create --compartment-id $compartment_id --query data.id --raw-output)
+
+       model_deployment_id=$(oci data-science model-deployment create --compartment-id $compartment_id --model-deployment-configuration-details file://model-deployment-configuration-details.json --project-id $project_id --query data.id --raw-output)
+
+       oci data-science model-deployment-model-state list --compartment-id $compartment_id --model-deployment-id $model_deployment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-science/model-deployment-model-state.txt

@@ -0,0 +1,14 @@
+model-deployment-model-state
+****************************
+
+
+Description
+===========
+
+Status of the model in a model group deployment.
+
+
+Available Commands
+==================
+
+* list

oci_cli/help_text_producer/data_files/text/cmdref/data-science/model-deployment.txt

@@ -18,6 +18,8 @@ Available Commands
 
 * create
 
+* create-model-deployment-model-group-deployment-configuration-details
+
 * deactivate
 
 * delete
@@ -27,3 +29,6 @@ Available Commands
 * list
 
 * update
+
+* update-model-deployment-update-model-group-deployment-configuration-
+  details