snowflake.ml.model.OutputSpec

class snowflake.ml.model.OutputSpec(*, stage_location: str, mode: SaveMode = SaveMode.ERROR)

Bases: BaseModel

Specification for batch inference output.

Defines where the inference results should be written and how to handle existing files at the output location.

stage_location

The stage path where batch inference results will be saved. This should be a full path including the stage with @ prefix. For example, ‘@My_DB.PUBLIC.MY_STAGE/someth/path/’. A non-existent directory will be re-created. Only Snowflake internal stages are supported at this moment.

Type:

str

mode

The save mode that determines behavior when files already exist at the output location. Defaults to SaveMode.ERROR which raises an error if files exist. Can be set to SaveMode.OVERWRITE to replace existing files.

Type:

SaveMode

Example

>>> output_spec = OutputSpec(
...     stage_location="@My_DB.PUBLIC.MY_STAGE/someth/path/",
...     mode=SaveMode.OVERWRITE
... )
Copy

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

Returns:

A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields: ClassVar[dict[str, FieldInfo]] = {'mode': FieldInfo(annotation=SaveMode, required=False, default=<SaveMode.ERROR: 'error'>), 'stage_location': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,

i.e. that were not filled from defaults.

stage_location: str
mode: SaveMode
Language: English