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

nemo_platform/types/safe_synthesizer/__init__.py

@@ -0,0 +1,68 @@
+# 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 .row import Row as Row
+from .column import Column as Column
+from .globals import Globals as Globals
+from .row_param import RowParam as RowParam
+from .ner_config import NERConfig as NERConfig
+from .row_actions import RowActions as RowActions
+from .column_param import ColumnParam as ColumnParam
+from .gliner_config import GlinerConfig as GlinerConfig
+from .globals_param import GlobalsParam as GlobalsParam
+from .column_actions import ColumnActions as ColumnActions
+from .classify_config import ClassifyConfig as ClassifyConfig
+from .data_parameters import DataParameters as DataParameters
+from .job_list_params import JobListParams as JobListParams
+from .step_definition import StepDefinition as StepDefinition
+from .ner_config_param import NERConfigParam as NERConfigParam
+from .job_create_params import JobCreateParams as JobCreateParams
+from .row_actions_param import RowActionsParam as RowActionsParam
+from .generate_parameters import GenerateParameters as GenerateParameters
+from .gliner_config_param import GlinerConfigParam as GlinerConfigParam
+from .job_get_logs_params import JobGetLogsParams as JobGetLogsParams
+from .pii_replacer_config import PIIReplacerConfig as PIIReplacerConfig
+from .column_actions_param import ColumnActionsParam as ColumnActionsParam
+from .safe_synthesizer_job import SafeSynthesizerJob as SafeSynthesizerJob
+from .training_hyperparams import TrainingHyperparams as TrainingHyperparams
+from .classify_config_param import ClassifyConfigParam as ClassifyConfigParam
+from .data_parameters_param import DataParametersParam as DataParametersParam
+from .evaluation_parameters import EvaluationParameters as EvaluationParameters
+from .step_definition_param import StepDefinitionParam as StepDefinitionParam
+from .validation_parameters import ValidationParameters as ValidationParameters
+from .time_series_parameters import TimeSeriesParameters as TimeSeriesParameters
+from .generate_parameters_param import GenerateParametersParam as GenerateParametersParam
+from .pii_replacer_config_param import PIIReplacerConfigParam as PIIReplacerConfigParam
+from .safe_synthesizer_jobs_page import SafeSynthesizerJobsPage as SafeSynthesizerJobsPage
+from .training_hyperparams_param import TrainingHyperparamsParam as TrainingHyperparamsParam
+from .evaluation_parameters_param import EvaluationParametersParam as EvaluationParametersParam
+from .safe_synthesizer_job_config import SafeSynthesizerJobConfig as SafeSynthesizerJobConfig
+from .safe_synthesizer_parameters import SafeSynthesizerParameters as SafeSynthesizerParameters
+from .validation_parameters_param import ValidationParametersParam as ValidationParametersParam
+from .time_series_parameters_param import TimeSeriesParametersParam as TimeSeriesParametersParam
+from .differential_privacy_hyperparams import DifferentialPrivacyHyperparams as DifferentialPrivacyHyperparams
+from .safe_synthesizer_jobs_sort_field import SafeSynthesizerJobsSortField as SafeSynthesizerJobsSortField
+from .safe_synthesizer_job_config_param import SafeSynthesizerJobConfigParam as SafeSynthesizerJobConfigParam
+from .safe_synthesizer_parameters_param import SafeSynthesizerParametersParam as SafeSynthesizerParametersParam
+from .differential_privacy_hyperparams_param import (
+    DifferentialPrivacyHyperparamsParam as DifferentialPrivacyHyperparamsParam,
+)
+from .safe_synthesizer_jobs_list_filter_param import (
+    SafeSynthesizerJobsListFilterParam as SafeSynthesizerJobsListFilterParam,
+)

nemo_platform/types/safe_synthesizer/classify_config.py

@@ -0,0 +1,41 @@
+# 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 List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ClassifyConfig"]
+
+
+class ClassifyConfig(BaseModel):
+    """Configuration for column classification using an LLM."""
+
+    classify_model_provider: Optional[str] = None
+    """Name of the model provider in the Inference Gateway for column classification.
+
+    The job compiler will resolve this to the appropriate endpoint URL.
+    """
+
+    enable_classify: Optional[bool] = None
+    """Enable column classification."""
+
+    entities: Optional[List[str]] = None
+    """List of entity types to classify."""
+
+    num_samples: Optional[int] = None
+    """Number of column values to sample for classification."""

nemo_platform/types/safe_synthesizer/classify_config_param.py

@@ -0,0 +1,43 @@
+# 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 ..._types import SequenceNotStr
+
+__all__ = ["ClassifyConfigParam"]
+
+
+class ClassifyConfigParam(TypedDict, total=False):
+    """Configuration for column classification using an LLM."""
+
+    classify_model_provider: str
+    """Name of the model provider in the Inference Gateway for column classification.
+
+    The job compiler will resolve this to the appropriate endpoint URL.
+    """
+
+    enable_classify: bool
+    """Enable column classification."""
+
+    entities: SequenceNotStr[str]
+    """List of entity types to classify."""
+
+    num_samples: int
+    """Number of column values to sample for classification."""

nemo_platform/types/safe_synthesizer/column.py

@@ -0,0 +1,46 @@
+# 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 List, Union, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Column"]
+
+
+class Column(BaseModel):
+    """
+    Rule matcher for selecting columns by name, position, condition, entity, or type.
+    """
+
+    condition: Optional[str] = None
+    """Column condition."""
+
+    entity: Union[str, List[str], None] = None
+    """Column entity match."""
+
+    name: Optional[str] = None
+    """Column name."""
+
+    position: Union[int, List[int], None] = None
+    """Column position."""
+
+    type: Union[str, List[str], None] = None
+    """Column type match."""
+
+    value: Optional[str] = None
+    """Rename to value."""

nemo_platform/types/safe_synthesizer/column_actions.py

@@ -0,0 +1,36 @@
+# 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 List, Optional
+
+from .column import Column
+from ..._models import BaseModel
+
+__all__ = ["ColumnActions"]
+
+
+class ColumnActions(BaseModel):
+    """Container for column add, drop, and rename operations."""
+
+    add: Optional[List[Column]] = None
+    """Columns to add."""
+
+    drop: Optional[List[Column]] = None
+    """Columns to drop."""
+
+    rename: Optional[List[Column]] = None
+    """Columns to rename."""

nemo_platform/types/safe_synthesizer/column_actions_param.py

@@ -0,0 +1,38 @@
+# 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 Iterable
+from typing_extensions import TypedDict
+
+from .column_param import ColumnParam
+
+__all__ = ["ColumnActionsParam"]
+
+
+class ColumnActionsParam(TypedDict, total=False):
+    """Container for column add, drop, and rename operations."""
+
+    add: Iterable[ColumnParam]
+    """Columns to add."""
+
+    drop: Iterable[ColumnParam]
+    """Columns to drop."""
+
+    rename: Iterable[ColumnParam]
+    """Columns to rename."""

nemo_platform/types/safe_synthesizer/column_param.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 import Union, Iterable
+from typing_extensions import TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["ColumnParam"]
+
+
+class ColumnParam(TypedDict, total=False):
+    """
+    Rule matcher for selecting columns by name, position, condition, entity, or type.
+    """
+
+    condition: str
+    """Column condition."""
+
+    entity: Union[str, SequenceNotStr[str]]
+    """Column entity match."""
+
+    name: str
+    """Column name."""
+
+    position: Union[int, Iterable[int]]
+    """Column position."""
+
+    type: Union[str, SequenceNotStr[str]]
+    """Column type match."""
+
+    value: str
+    """Rename to value."""

nemo_platform/types/safe_synthesizer/data_parameters.py

@@ -0,0 +1,69 @@
+# 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 Union, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["DataParameters"]
+
+
+class DataParameters(BaseModel):
+    """
+    Configuration for grouping, ordering, and splitting input data for training and evaluation.
+    """
+
+    group_training_examples_by: Optional[str] = None
+    """Column to group training examples by.
+
+    This is useful when you want the model to learn inter-record correlations for a
+    given grouping of records.
+    """
+
+    holdout: Optional[float] = None
+    """Amount of records to hold out for evaluation.
+
+    If this is a float between 0 and 1, that ratio of records is held out. If an
+    integer greater than 1, that number of records is held out. If the value is
+    equal to zero, no holdout will be performed. Must be >= 0.
+    """
+
+    max_holdout: Optional[int] = None
+    """Maximum number of records to hold out.
+
+    Overrides any behavior set by `holdout`. Must be >= 0.
+    """
+
+    max_sequences_per_example: Union[Literal["auto"], int, None] = None
+    """If specified, adds at most this number of sequences per example.
+
+    Supports 'auto' where a value of 1 is chosen if differential privacy is enabled,
+    and 10 otherwise. If not specified or set to 'auto', fills up context. Required
+    for DP to limit contribution of each example.
+    """
+
+    order_training_examples_by: Optional[str] = None
+    """Column to order training examples by.
+
+    This is useful when you want the model to learn sequential relationships for a
+    given ordering of records. If you provide this parameter, you must also provide
+    `group_training_examples_by`.
+    """
+
+    random_state: Optional[int] = None
+    """Random state for holdout split to ensure reproducibility."""

nemo_platform/types/safe_synthesizer/data_parameters_param.py

@@ -0,0 +1,69 @@
+# 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 Literal, TypedDict
+
+__all__ = ["DataParametersParam"]
+
+
+class DataParametersParam(TypedDict, total=False):
+    """
+    Configuration for grouping, ordering, and splitting input data for training and evaluation.
+    """
+
+    group_training_examples_by: str
+    """Column to group training examples by.
+
+    This is useful when you want the model to learn inter-record correlations for a
+    given grouping of records.
+    """
+
+    holdout: float
+    """Amount of records to hold out for evaluation.
+
+    If this is a float between 0 and 1, that ratio of records is held out. If an
+    integer greater than 1, that number of records is held out. If the value is
+    equal to zero, no holdout will be performed. Must be >= 0.
+    """
+
+    max_holdout: int
+    """Maximum number of records to hold out.
+
+    Overrides any behavior set by `holdout`. Must be >= 0.
+    """
+
+    max_sequences_per_example: Union[Literal["auto"], int]
+    """If specified, adds at most this number of sequences per example.
+
+    Supports 'auto' where a value of 1 is chosen if differential privacy is enabled,
+    and 10 otherwise. If not specified or set to 'auto', fills up context. Required
+    for DP to limit contribution of each example.
+    """
+
+    order_training_examples_by: str
+    """Column to order training examples by.
+
+    This is useful when you want the model to learn sequential relationships for a
+    given ordering of records. If you provide this parameter, you must also provide
+    `group_training_examples_by`.
+    """
+
+    random_state: int
+    """Random state for holdout split to ensure reproducibility."""

nemo_platform/types/safe_synthesizer/differential_privacy_hyperparams.py

@@ -0,0 +1,48 @@
+# 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 Union, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["DifferentialPrivacyHyperparams"]
+
+
+class DifferentialPrivacyHyperparams(BaseModel):
+    """Hyperparameters for differential privacy during training.
+
+    These parameters configure differential privacy (DP) training using DP-SGD algorithm.
+    When enabled, they provide formal privacy guarantees by adding calibrated noise
+    during training.
+    """
+
+    delta: Union[Literal["auto"], float, None] = None
+    """Probability of accidentally leaking information.
+
+    Should be much smaller than 1/n where n is the number of training records.
+    Setting to 'auto' uses delta of 1/n^1.2. Must be in [0, 1) or 'auto'.
+    """
+
+    dp_enabled: Optional[bool] = None
+    """Enable differentially-private training with DP-SGD."""
+
+    epsilon: Optional[float] = None
+    """Target privacy budget -- lower values provide stronger privacy. Must be > 0."""
+
+    per_sample_max_grad_norm: Optional[float] = None
+    """Maximum L2 norm for per-sample gradient clipping. Must be > 0."""

nemo_platform/types/safe_synthesizer/differential_privacy_hyperparams_param.py

@@ -0,0 +1,48 @@
+# 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 Literal, TypedDict
+
+__all__ = ["DifferentialPrivacyHyperparamsParam"]
+
+
+class DifferentialPrivacyHyperparamsParam(TypedDict, total=False):
+    """Hyperparameters for differential privacy during training.
+
+    These parameters configure differential privacy (DP) training using DP-SGD algorithm.
+    When enabled, they provide formal privacy guarantees by adding calibrated noise
+    during training.
+    """
+
+    delta: Union[Literal["auto"], float]
+    """Probability of accidentally leaking information.
+
+    Should be much smaller than 1/n where n is the number of training records.
+    Setting to 'auto' uses delta of 1/n^1.2. Must be in [0, 1) or 'auto'.
+    """
+
+    dp_enabled: bool
+    """Enable differentially-private training with DP-SGD."""
+
+    epsilon: float
+    """Target privacy budget -- lower values provide stronger privacy. Must be > 0."""
+
+    per_sample_max_grad_norm: float
+    """Maximum L2 norm for per-sample gradient clipping. Must be > 0."""

nemo_platform/types/safe_synthesizer/evaluation_parameters.py

@@ -0,0 +1,64 @@
+# 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 List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["EvaluationParameters"]
+
+
+class EvaluationParameters(BaseModel):
+    """Configuration for evaluating synthetic data quality and privacy.
+
+    This class controls which evaluation metrics are computed and how they are configured.
+    It includes privacy attack evaluations, statistical quality metrics, and downstream
+    machine learning performance assessments.
+    """
+
+    aia_enabled: Optional[bool] = None
+    """Enable attribute inference attack evaluation for privacy assessment."""
+
+    enabled: Optional[bool] = None
+    """Enable or disable evaluation."""
+
+    mandatory_columns: Optional[int] = None
+    """Number of mandatory columns that must be used in evaluation."""
+
+    mia_enabled: Optional[bool] = None
+    """Enable membership inference attack evaluation for privacy assessment."""
+
+    pii_replay_columns: Optional[List[str]] = None
+    """List of columns for PII Replay. If not provided, only entities will be used."""
+
+    pii_replay_enabled: Optional[bool] = None
+    """Enable PII Replay detection."""
+
+    pii_replay_entities: Optional[List[str]] = None
+    """List of entities for PII Replay.
+
+    If not provided, default entities will be used.
+    """
+
+    quasi_identifier_count: Optional[int] = None
+    """Number of quasi-identifiers to sample for privacy attacks."""
+
+    sqs_report_columns: Optional[int] = None
+    """Number of columns to include in statistical quality reports."""
+
+    sqs_report_rows: Optional[int] = None
+    """Number of rows to include in statistical quality reports."""