Models

geostudio.backends.v2.ginference.models

ModelOnboardingInputSchema

Bases: BaseModel

Used by:

SDK Client Inference client Client deploy_model

ModelUpdateInput

Bases: BaseModel

Subclassed by:

Models Models models ModelCreateInput

Used by:

SDK Client Inference client Client update_model

ModelCreateInput

Bases: ModelUpdateInput

Used by:

SDK Client Inference client Client create_model

SpatialDomain

Bases: BaseModel

DataSource

Bases: BaseModel

GeoServerPush

Bases: BaseModel

PostProcessing

Bases: BaseModel

InferenceConfig

Bases: BaseModel

Subclassed by:

Models Models models InferenceCreateInput

InferenceCreateInput

Bases: InferenceConfig

Used by:

SDK Client Inference client Client submit_inference

DataAdvisorIn

Bases: BaseModel

Used by:

SDK Client Inference client Client check_data_availability

geostudio.backends.v2.gtune.models

TuneUpdateIn

Bases: BaseModel

Used by:

SDK Client Fine-tuning client Client update_tune

TuneSubmitBase

Bases: BaseModel

Subclassed by:

Models Models models TuneSubmitIn

validate_name `classmethod`

validate_name(name: str) -> str

Validates the tune name

Parameters

name : str The name of the tune.

Returns

str Cleaned up name of the tune without special characters or white spaces.

Raises

ValueError If name contains special characters or white spaces.

Source code in geostudio/backends/v2/gtune/models.py

@field_validator("name")
@classmethod
def validate_name(cls, name: str) -> str:
    """Validates the tune name

    Parameters
    ----------
    name : str
        The name of the tune.

    Returns
    -------
    str
        Cleaned up name of the tune without special characters or white spaces.

    Raises
    ------
    ValueError
         If `name` contains special characters or white spaces.
    """
    # Clean-up the tune name.
    name = name.replace(" ", "-").replace("_", "-").strip()
    if not re.match("^[a-zA-Z0-9]+([.-]{0,1}[a-zA-Z0-9]+)*$", name):
        raise ValueError("must not contain special characters or white spaces. Replace underscores with hyphens.")
    return name