"create-from-huggingface"
*************************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Import a model from ModelDataSource.

The header contains an opc-work-request-id, which is the id for the
WorkRequest that tracks the importedModel creation progress.


Usage
=====

   oci generative-ai imported-model create-from-huggingface [OPTIONS]


Required Parameters
===================

--compartment-id, -c [text]

The compartment OCID from which the model is imported.

--model-id [text]

The full model OCID from Hugging Face, typically in the format “org
/model-name” (e.g., “meta-llama/Llama-2-7b”).


Optional Parameters
===================

--access-token [text]

Hugging Face access token to authenticate requests for restricted
models. This token will be securely stored in OCI Vault.

--branch [text]

The name of the branch in the Hugging Face repository to import the
model from. If not specified, “main” will be used by default. If you
provide both a branch and a commit hash, the model will be imported
from the specified commit.

--capabilities [text]

Specifies the intended use or supported capabilities of the imported
model.

Accepted values are:

   EMBEDDING, IMAGE_TEXT_TO_TEXT, RERANK, TEXT_TO_IMAGE, TEXT_TO_TEXT

--commit [text]

The commit hash in the Hugging Face repository to import the model
from. If both a branch and a commit are provided, the commit hash will
be used.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, 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]

An optional description of the imported model.

--display-name [text]

A user-friendly name for the imported model.

--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. For more information, 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.

--vendor [text]

The provider of the imported model.

--version [text]

The version of the imported model.

--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" ACCEPTED
"--wait-for-state" CANCELED 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, WAITING

--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", "--enable-dual-stack", "--enable-propagation", "--
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 generative-ai model create --generate-param-json-input fine-tune-details > fine-tune-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 base_model_id=<substitute-value-of-base_model_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/model/create.html#cmdoption-base-model-id
       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai/model/create.html#cmdoption-compartment-id

       model_id=$(oci generative-ai model create --base-model-id $base_model_id --compartment-id $compartment_id --fine-tune-details file://fine-tune-details.json --query data.id --raw-output)

       oci generative-ai imported-model create-from-huggingface --compartment-id $compartment_id --model-id $model_id
