shaped 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py

@@ -0,0 +1,154 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.embedder_batch_size import EmbedderBatchSize
+from shaped.autogen.models.lr import Lr
+from shaped.autogen.models.max_seq_length import MaxSeqLength
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'beeformer'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    device: Optional[StrictStr] = None
+    seed: Optional[StrictInt] = Field(default=42, description="Random seed for reproducibility.")
+    lr: Optional[Lr] = None
+    use_scheduler: Optional[StrictBool] = Field(default=False, description="Whether to use a learning rate scheduler.")
+    epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
+    max_output: Optional[StrictInt] = Field(default=1, description="Negative sampling hyperparameter, uniform.")
+    batch_size: Optional[StrictInt] = Field(default=1024, description="Number of samples processed before updating model weights.")
+    top_k: Optional[StrictInt] = Field(default=0, description="Optimize only for top-k predictions on the output.")
+    embedder: Optional[StrictStr] = 'all-mpnet-base-v2'
+    use_images: Optional[StrictBool] = Field(default=False, description="Use image features.")
+    max_seq_length: Optional[MaxSeqLength] = None
+    embedder_batch_size: Optional[EmbedderBatchSize] = None
+    train_distributed: Optional[StrictBool] = Field(default=False, description="Train on multiple devices.")
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "device", "seed", "lr", "use_scheduler", "epochs", "max_output", "batch_size", "top_k", "embedder", "use_images", "max_seq_length", "embedder_batch_size", "train_distributed"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['beeformer']):
+            raise ValueError("must be one of enum values ('beeformer')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of lr
+        if self.lr:
+            _dict['lr'] = self.lr.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of max_seq_length
+        if self.max_seq_length:
+            _dict['max_seq_length'] = self.max_seq_length.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of embedder_batch_size
+        if self.embedder_batch_size:
+            _dict['embedder_batch_size'] = self.embedder_batch_size.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if event_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.event_values is None and "event_values" in self.model_fields_set:
+            _dict['event_values'] = None
+
+        # set to None if device (nullable) is None
+        # and model_fields_set contains the field
+        if self.device is None and "device" in self.model_fields_set:
+            _dict['device'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'beeformer',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "device": obj.get("device"),
+            "seed": obj.get("seed") if obj.get("seed") is not None else 42,
+            "lr": Lr.from_dict(obj["lr"]) if obj.get("lr") is not None else None,
+            "use_scheduler": obj.get("use_scheduler") if obj.get("use_scheduler") is not None else False,
+            "epochs": obj.get("epochs") if obj.get("epochs") is not None else 1,
+            "max_output": obj.get("max_output") if obj.get("max_output") is not None else 1,
+            "batch_size": obj.get("batch_size") if obj.get("batch_size") is not None else 1024,
+            "top_k": obj.get("top_k") if obj.get("top_k") is not None else 0,
+            "embedder": obj.get("embedder") if obj.get("embedder") is not None else 'all-mpnet-base-v2',
+            "use_images": obj.get("use_images") if obj.get("use_images") is not None else False,
+            "max_seq_length": MaxSeqLength.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
+            "embedder_batch_size": EmbedderBatchSize.from_dict(obj["embedder_batch_size"]) if obj.get("embedder_batch_size") is not None else None,
+            "train_distributed": obj.get("train_distributed") if obj.get("train_distributed") is not None else False
+        })
+        return _obj
+
+

shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py

@@ -0,0 +1,209 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.attn_dropout_prob import AttnDropoutProb
+from shaped.autogen.models.batch_size import BatchSize
+from shaped.autogen.models.hidden_dropout_prob import HiddenDropoutProb
+from shaped.autogen.models.hidden_size import HiddenSize
+from shaped.autogen.models.inner_size import InnerSize
+from shaped.autogen.models.learning_rate import LearningRate
+from shaped.autogen.models.loss_types import LossTypes
+from shaped.autogen.models.max_seq_length1 import MaxSeqLength1
+from shaped.autogen.models.n_epochs import NEpochs
+from shaped.autogen.models.n_heads import NHeads
+from shaped.autogen.models.n_layers import NLayers
+from shaped.autogen.models.sampling_strategy import SamplingStrategy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'bert4rec'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    batch_size: Optional[BatchSize] = None
+    eval_batch_size: Optional[StrictInt] = Field(default=1000, description="Batch size used during model evaluation.")
+    n_epochs: Optional[NEpochs] = None
+    negative_samples_count: Optional[StrictInt] = Field(default=2, description="Number of negative samples per positive sample for contrastive learning.")
+    device: Optional[StrictStr] = None
+    hidden_size: Optional[HiddenSize] = None
+    inner_size: Optional[InnerSize] = None
+    learning_rate: Optional[LearningRate] = None
+    attn_dropout_prob: Optional[AttnDropoutProb] = None
+    hidden_act: Optional[StrictStr] = 'gelu'
+    hidden_dropout_prob: Optional[HiddenDropoutProb] = None
+    n_heads: Optional[NHeads] = None
+    n_layers: Optional[NLayers] = None
+    layer_norm_eps: Optional[Union[StrictFloat, StrictInt]] = 1.0E-12
+    initializer_range: Optional[Union[StrictFloat, StrictInt]] = 0.02
+    mask_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.2, description="Fraction of tokens to mask during training.")
+    loss_type: Optional[LossTypes] = None
+    max_seq_length: Optional[MaxSeqLength1] = None
+    sample_strategy: Optional[SamplingStrategy] = None
+    sample_seed: Optional[StrictInt] = 42
+    sample_ratio: Optional[Union[StrictFloat, StrictInt]] = 0.8
+    eval_step: Optional[StrictInt] = 1
+    early_stopping_step: Optional[StrictInt] = 5
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "eval_batch_size", "n_epochs", "negative_samples_count", "device", "hidden_size", "inner_size", "learning_rate", "attn_dropout_prob", "hidden_act", "hidden_dropout_prob", "n_heads", "n_layers", "layer_norm_eps", "initializer_range", "mask_rate", "loss_type", "max_seq_length", "sample_strategy", "sample_seed", "sample_ratio", "eval_step", "early_stopping_step"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['bert4rec']):
+            raise ValueError("must be one of enum values ('bert4rec')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of batch_size
+        if self.batch_size:
+            _dict['batch_size'] = self.batch_size.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of n_epochs
+        if self.n_epochs:
+            _dict['n_epochs'] = self.n_epochs.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of hidden_size
+        if self.hidden_size:
+            _dict['hidden_size'] = self.hidden_size.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of inner_size
+        if self.inner_size:
+            _dict['inner_size'] = self.inner_size.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of learning_rate
+        if self.learning_rate:
+            _dict['learning_rate'] = self.learning_rate.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of attn_dropout_prob
+        if self.attn_dropout_prob:
+            _dict['attn_dropout_prob'] = self.attn_dropout_prob.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of hidden_dropout_prob
+        if self.hidden_dropout_prob:
+            _dict['hidden_dropout_prob'] = self.hidden_dropout_prob.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of n_heads
+        if self.n_heads:
+            _dict['n_heads'] = self.n_heads.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of n_layers
+        if self.n_layers:
+            _dict['n_layers'] = self.n_layers.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of max_seq_length
+        if self.max_seq_length:
+            _dict['max_seq_length'] = self.max_seq_length.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if event_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.event_values is None and "event_values" in self.model_fields_set:
+            _dict['event_values'] = None
+
+        # set to None if device (nullable) is None
+        # and model_fields_set contains the field
+        if self.device is None and "device" in self.model_fields_set:
+            _dict['device'] = None
+
+        # set to None if sample_strategy (nullable) is None
+        # and model_fields_set contains the field
+        if self.sample_strategy is None and "sample_strategy" in self.model_fields_set:
+            _dict['sample_strategy'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'bert4rec',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "batch_size": BatchSize.from_dict(obj["batch_size"]) if obj.get("batch_size") is not None else None,
+            "eval_batch_size": obj.get("eval_batch_size") if obj.get("eval_batch_size") is not None else 1000,
+            "n_epochs": NEpochs.from_dict(obj["n_epochs"]) if obj.get("n_epochs") is not None else None,
+            "negative_samples_count": obj.get("negative_samples_count") if obj.get("negative_samples_count") is not None else 2,
+            "device": obj.get("device"),
+            "hidden_size": HiddenSize.from_dict(obj["hidden_size"]) if obj.get("hidden_size") is not None else None,
+            "inner_size": InnerSize.from_dict(obj["inner_size"]) if obj.get("inner_size") is not None else None,
+            "learning_rate": LearningRate.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
+            "attn_dropout_prob": AttnDropoutProb.from_dict(obj["attn_dropout_prob"]) if obj.get("attn_dropout_prob") is not None else None,
+            "hidden_act": obj.get("hidden_act") if obj.get("hidden_act") is not None else 'gelu',
+            "hidden_dropout_prob": HiddenDropoutProb.from_dict(obj["hidden_dropout_prob"]) if obj.get("hidden_dropout_prob") is not None else None,
+            "n_heads": NHeads.from_dict(obj["n_heads"]) if obj.get("n_heads") is not None else None,
+            "n_layers": NLayers.from_dict(obj["n_layers"]) if obj.get("n_layers") is not None else None,
+            "layer_norm_eps": obj.get("layer_norm_eps") if obj.get("layer_norm_eps") is not None else 1.0E-12,
+            "initializer_range": obj.get("initializer_range") if obj.get("initializer_range") is not None else 0.02,
+            "mask_rate": obj.get("mask_rate") if obj.get("mask_rate") is not None else 0.2,
+            "loss_type": obj.get("loss_type"),
+            "max_seq_length": MaxSeqLength1.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
+            "sample_strategy": obj.get("sample_strategy"),
+            "sample_seed": obj.get("sample_seed") if obj.get("sample_seed") is not None else 42,
+            "sample_ratio": obj.get("sample_ratio") if obj.get("sample_ratio") is not None else 0.8,
+            "eval_step": obj.get("eval_step") if obj.get("eval_step") is not None else 1,
+            "early_stopping_step": obj.get("early_stopping_step") if obj.get("early_stopping_step") is not None else 5
+        })
+        return _obj
+
+

shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.ascending import Ascending
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'chronological'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    time_col: Optional[StrictStr] = None
+    ascending: Optional[Ascending] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "time_col", "ascending"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['chronological']):
+            raise ValueError("must be one of enum values ('chronological')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of ascending
+        if self.ascending:
+            _dict['ascending'] = self.ascending.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if event_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.event_values is None and "event_values" in self.model_fields_set:
+            _dict['event_values'] = None
+
+        # set to None if time_col (nullable) is None
+        # and model_fields_set contains the field
+        if self.time_col is None and "time_col" in self.model_fields_set:
+            _dict['time_col'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'chronological',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "time_col": obj.get("time_col"),
+            "ascending": Ascending.from_dict(obj["ascending"]) if obj.get("ascending") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py

@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.factors import Factors
+from shaped.autogen.models.lr1 import Lr1
+from shaped.autogen.models.training_strategy import TrainingStrategy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'elsa'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    batch_size: Optional[StrictInt] = Field(default=512, description="Number of samples processed before updating model weights.")
+    n_epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
+    factors: Optional[Factors] = None
+    lr: Optional[Lr1] = None
+    device: Optional[StrictStr] = None
+    strategy: Optional[TrainingStrategy] = None
+    patience: Optional[StrictInt] = Field(default=3, description="Number of epochs to wait without improvement before early stopping.")
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "n_epochs", "factors", "lr", "device", "strategy", "patience"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['elsa']):
+            raise ValueError("must be one of enum values ('elsa')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of factors
+        if self.factors:
+            _dict['factors'] = self.factors.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of lr
+        if self.lr:
+            _dict['lr'] = self.lr.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if event_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.event_values is None and "event_values" in self.model_fields_set:
+            _dict['event_values'] = None
+
+        # set to None if device (nullable) is None
+        # and model_fields_set contains the field
+        if self.device is None and "device" in self.model_fields_set:
+            _dict['device'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'elsa',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "batch_size": obj.get("batch_size") if obj.get("batch_size") is not None else 512,
+            "n_epochs": obj.get("n_epochs") if obj.get("n_epochs") is not None else 1,
+            "factors": Factors.from_dict(obj["factors"]) if obj.get("factors") is not None else None,
+            "lr": Lr1.from_dict(obj["lr"]) if obj.get("lr") is not None else None,
+            "device": obj.get("device"),
+            "strategy": obj.get("strategy"),
+            "patience": obj.get("patience") if obj.get("patience") is not None else 3
+        })
+        return _obj
+
+