nemo-platform-plugin 0.1.0__py3-none-any.whl

nemo_platform/types/models/model_entity.py

@@ -0,0 +1,112 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from .adapter import Adapter
+from ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+from ..shared.model_spec import ModelSpec
+from ..shared.prompt_data import PromptData
+from ..shared.backend_format import BackendFormat
+from ..shared.finetuning_type import FinetuningType
+from ..shared.api_endpoint_data import APIEndpointData
+
+__all__ = ["ModelEntity"]
+
+
+class ModelEntity(BaseModel):
+    """
+    Model Entity represents a versioned model registered within the platform.
+    Uses EntityBase for entity store compatibility.
+    """
+
+    id: str
+    """Autogenerated id"""
+
+    created_at: datetime
+    """The timestamp of model entity creation"""
+
+    name: str
+    """Name of the entity.
+
+    Name/workspace combo must be unique across all entities. Allowed characters:
+    letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.
+    """
+
+    updated_at: datetime
+    """The timestamp of the last model entity update"""
+
+    workspace: str
+    """The workspace of the entity.
+
+    Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and
+    dots.
+    """
+
+    adapters: Optional[List[Adapter]] = None
+    """Adapters that have been created against this model"""
+
+    api_endpoint: Optional[APIEndpointData] = None
+    """Data about an inference endpoint."""
+
+    backend_format: Optional[BackendFormat] = None
+    """Inference backend API wire formats understood by IGW and middleware plugins."""
+
+    base_model: Optional[str] = None
+    """Link to another model which is used as a base for the current model"""
+
+    custom_fields: Optional[Dict[str, object]] = None
+    """Custom fields for additional metadata"""
+
+    description: Optional[str] = None
+    """Optional description of the model."""
+
+    fileset: Optional[str] = None
+    """
+    A set of checkpoint files, configs, and other auxiliary info associated with
+    this model - expected format {workspace}/{fileset_name}
+    """
+
+    finetuning_type: Optional[FinetuningType] = None
+    """Finetuning types."""
+
+    model_providers: Optional[List[str]] = None
+    """
+    List of ModelProvider workspace/name resource names that provide inference for
+    this Model Entity
+    """
+
+    ownership: Optional[Dict[str, object]] = None
+    """Ownership information for the model"""
+
+    project: Optional[str] = None
+    """The URN of the project associated with this model entity."""
+
+    prompt: Optional[PromptData] = None
+    """Configuration for prompt engineering."""
+
+    spec: Optional[ModelSpec] = None
+    """Detailed specification for a model."""
+
+    trust_remote_code: Optional[bool] = None
+    """Whether to trust remote code to load this model checkpoint."""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

nemo_platform/types/models/model_entity_filter_param.py

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import TypeAlias, TypedDict
+
+from ..shared.finetuning_type import FinetuningType
+from .base_model_filter_param import BaseModelFilterParam
+from .finetuning_type_filter_param import FinetuningTypeFilterParam
+from ..shared_params.datetime_filter import DatetimeFilter
+
+__all__ = ["ModelEntityFilterParam", "Adapters", "BaseModel"]
+
+Adapters: TypeAlias = Union[FinetuningTypeFilterParam, bool]
+
+BaseModel: TypeAlias = Union[BaseModelFilterParam, bool, str]
+
+
+class ModelEntityFilterParam(TypedDict, total=False):
+    """Filter for Model Entity queries."""
+
+    adapters: Adapters
+    """Filter models with Parameter Efficient Fine-tuning Adapters."""
+
+    base_model: BaseModel
+    """
+    Filter by base model: true = has a base model, false = no base model, { name:
+    string } or string = match base model name.
+    """
+
+    created_at: DatetimeFilter
+    """Filter entities based on creation date."""
+
+    description: str
+    """Filter by description."""
+
+    finetuning_type: Union[FinetuningType, bool]
+    """Filter models that have been perviously finetuned."""
+
+    lora_enabled: bool
+    """Filter models by whether their deployment config has LoRA enabled."""
+
+    name: str
+    """Filter by name."""
+
+    project: str
+    """Filter by project name."""
+
+    prompt: bool
+    """Filter models with prompt engineering data."""
+
+    updated_at: DatetimeFilter
+    """Filter entities based on update date."""
+
+    workspace: str
+    """Filter by workspace id."""

nemo_platform/types/models/model_entity_sort_field.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ModelEntitySortField"]
+
+ModelEntitySortField: TypeAlias = Literal["name", "-name", "created_at", "-created_at", "updated_at", "-updated_at"]

nemo_platform/types/models/model_entitys_page.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+from .model_entity import ModelEntity
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["ModelEntitysPage"]
+
+
+class ModelEntitysPage(BaseModel):
+    data: List[ModelEntity]
+
+    filter: Optional[Dict[str, object]] = None
+    """Filtering information."""
+
+    pagination: Optional[PaginationData] = None
+    """Pagination information."""
+
+    sort: Optional[str] = None
+    """The field on which the results are sorted."""

nemo_platform/types/models/model_list_params.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .model_entity_sort_field import ModelEntitySortField
+from .model_entity_filter_param import ModelEntityFilterParam
+
+__all__ = ["ModelListParams"]
+
+
+class ModelListParams(TypedDict, total=False):
+    workspace: str
+
+    filter: ModelEntityFilterParam
+    """
+    Filter models by name, project, workspace, base_model, adapters,
+    finetuning_type, prompt, lora_enabled, description, created_at, and updated_at.
+    """
+
+    page: int
+    """Page number."""
+
+    page_size: int
+    """Page size."""
+
+    sort: ModelEntitySortField
+    """The field to sort by.
+
+    To sort in decreasing order, use `-` in front of the field name.
+    """
+
+    verbose: bool
+    """Whether to include full spec details"""

nemo_platform/types/models/model_retrieve_params.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ModelRetrieveParams"]
+
+
+class ModelRetrieveParams(TypedDict, total=False):
+    workspace: str
+
+    verbose: bool
+    """Whether to include full spec details"""

nemo_platform/types/models/model_update_params.py

@@ -0,0 +1,86 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import TypedDict
+
+from ..._types import SequenceNotStr
+from ..shared.backend_format import BackendFormat
+from ..shared.finetuning_type import FinetuningType
+from ..shared_params.model_spec import ModelSpec
+from ..shared_params.prompt_data import PromptData
+from ..shared_params.api_endpoint_data import APIEndpointData
+
+__all__ = ["ModelUpdateParams"]
+
+
+class ModelUpdateParams(TypedDict, total=False):
+    workspace: str
+
+    verbose: bool
+    """Whether to include full spec details"""
+
+    api_endpoint: APIEndpointData
+    """Data about an inference endpoint."""
+
+    backend_format: Optional[BackendFormat]
+    """Inference backend API wire formats understood by IGW and middleware plugins."""
+
+    base_model: str
+    """Link to another model which is used as a base for the current model"""
+
+    custom_fields: Dict[str, object]
+    """Custom fields for additional metadata"""
+
+    description: str
+    """Optional description of the model"""
+
+    fileset: str
+    """
+    A set of checkpoint files, configs, and other auxiliary info associated with
+    this model - expected format {workspace}/{fileset_name}
+    """
+
+    finetuning_type: FinetuningType
+    """Finetuning types."""
+
+    model_providers: SequenceNotStr[str]
+    """
+    List of ModelProvider workspace/name resource names that provide inference for
+    this Model Entity
+    """
+
+    ownership: Dict[str, object]
+    """Ownership information for the model"""
+
+    prompt: PromptData
+    """Configuration for prompt engineering."""
+
+    spec: ModelSpec
+    """Detailed specification for a model."""
+
+    trust_remote_code: bool
+    """
+    Whether to trust remote code for the checkpoint. Some models without support in
+    certain libraries such as Transformers require additional custom Python code to
+    execute. Due to security ramifications of running arbitrary code, this can only
+    be set to true on one of the following conditions: (1) the model's fileset's
+    source is pre-approved in the platform config, or (2) the user creating this
+    model is an administrator.
+    """

nemo_platform/types/projects/__init__.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .project import Project as Project
+from .projects_page import ProjectsPage as ProjectsPage
+from .project_sort_field import ProjectSortField as ProjectSortField
+from .project_list_params import ProjectListParams as ProjectListParams
+from .project_create_params import ProjectCreateParams as ProjectCreateParams
+from .project_update_params import ProjectUpdateParams as ProjectUpdateParams

nemo_platform/types/projects/project.py

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["Project"]
+
+
+class Project(BaseModel):
+    """Schema for Project responses."""
+
+    id: str
+    """Unique identifier"""
+
+    created_at: datetime
+    """Creation timestamp"""
+
+    name: str
+    """Project name"""
+
+    updated_at: datetime
+    """Last update timestamp"""
+
+    workspace: str
+    """Workspace identifier"""
+
+    description: Optional[str] = None
+    """Project description"""

nemo_platform/types/projects/project_create_params.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ProjectCreateParams"]
+
+
+class ProjectCreateParams(TypedDict, total=False):
+    workspace: str
+
+    name: Required[str]
+    """Project name (unique within workspace).
+
+    Name must start with a lowercase letter, be 2-63 characters, and contain only
+    lowercase letters, digits, and hyphens (no consecutive hyphens, cannot end with
+    a hyphen).
+    """
+
+    description: str
+    """Optional description of the project"""

nemo_platform/types/projects/project_list_params.py

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .project_sort_field import ProjectSortField
+
+__all__ = ["ProjectListParams"]
+
+
+class ProjectListParams(TypedDict, total=False):
+    workspace: str
+
+    filter: str
+    """Query filter expression. Supports text and JSON syntaxes:
+
+    - Text: name:"value" AND status>500 with operators : ~ > >= < <= IN NOT IN AND
+      OR and negation prefix -
+    - Object (JSON): {"name":{"$like":"value"}} with operators $eq, $like, $lt,
+      $lte, $gt, $gte, $in, $nin, $and, $or, $not
+    - Bracket notation: ?filter[name][$like]=value
+    - Relationship traversal: ?filter[relationship][$exists]=true or
+      ?filter[relationship][field]=value
+    """
+
+    page: int
+    """Page number"""
+
+    page_size: int
+    """Items per page"""
+
+    sort: ProjectSortField
+    """Sort field"""

nemo_platform/types/projects/project_sort_field.py

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ProjectSortField"]
+
+ProjectSortField: TypeAlias = Literal["created_at", "-created_at", "updated_at", "-updated_at", "name", "-name"]

nemo_platform/types/projects/project_update_params.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["ProjectUpdateParams"]
+
+
+class ProjectUpdateParams(TypedDict, total=False):
+    workspace: str
+
+    description: str
+    """Updated description"""

nemo_platform/types/projects/projects_page.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .project import Project
+from ..._models import BaseModel
+from ..shared.pagination_data import PaginationData
+
+__all__ = ["ProjectsPage"]
+
+
+class ProjectsPage(BaseModel):
+    data: List[Project]
+
+    filter: Optional[Dict[str, object]] = None
+    """Filtering information."""
+
+    pagination: Optional[PaginationData] = None
+    """Pagination information."""
+
+    sort: Optional[str] = None
+    """The field on which the results are sorted."""