nemo_microservices.types.model_param#

Module Contents#

Classes#

ModelParam

API#

class nemo_microservices.types.model_param.ModelParam#

Bases: typing_extensions.TypedDict

api_endpoint: nemo_microservices.types.shared_params.api_endpoint_data.APIEndpointData#

None

Data about an API endpoint.

artifact: nemo_microservices.types.shared_params.model_artifact.ModelArtifact#

None

Data about a model artifact (a set of checkpoint files, configs, and other auxiliary info).

The files_url field can point to a DataStore location.

Example:

  • nds://models/rdinu/my-lora-customization

The rdinu/my-lora-customization part above is the actual repository.

If a specific revision needs to be referred, the HuggingFace syntax is used.

  • nds://models/rdinu/my-lora-customization@v1

  • nds://models/rdinu/my-lora-customization@8df79a8

base_model: str | Dict[str, object]#

None

Link to another model which is used as a base for the current model.

custom_fields: Dict[str, object]#

None

A set of custom fields that the user can define and use for various purposes.

description: str#

None

The description of the entity.

guardrails: nemo_microservices.types.shared_params.guardrail_config_param.GuardrailConfigParam#

None

A guardrail configuration

model_providers: nemo_microservices._types.SequenceNotStr[str]#

None

List of ModelProvider namespace/name resource names that provide inference for this Model Entity

name: str#

None

The name of the entity.

Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

namespace: str#

None

The namespace of the entity.

This can be missing for namespace entities or in deployments that don’t use namespaces.

ownership: nemo_microservices.types.shared_params.ownership.Ownership#

None

Information about ownership of an entity.

If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

peft: nemo_microservices.types.shared_params.parameter_efficient_finetuning_data.ParameterEfficientFinetuningData#

None

Data about a parameter-efficient finetuning.

project: str#

None

The URN of the project associated with this entity.

prompt: nemo_microservices.types.shared_params.prompt_data.PromptData#

None

Prompt engineering data.

spec: nemo_microservices.types.shared_params.model_spec.ModelSpec#

None

Detailed specification about a model.