together 1.2.11__py3-none-any.whl → 2.0.0a8__py3-none-any.whl

together/types/evaluation_job.py

@@ -0,0 +1,139 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "EvaluationJob",
+    "Results",
+    "ResultsEvaluationClassifyResults",
+    "ResultsEvaluationScoreResults",
+    "ResultsEvaluationScoreResultsAggregatedScores",
+    "ResultsEvaluationCompareResults",
+    "ResultsError",
+    "StatusUpdate",
+]
+
+
+class ResultsEvaluationClassifyResults(BaseModel):
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_label_count: Optional[float] = None
+    """Number of invalid labels"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    label_counts: Optional[str] = None
+    """JSON string representing label counts"""
+
+    pass_percentage: Optional[float] = None
+    """Pecentage of pass labels."""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationScoreResultsAggregatedScores(BaseModel):
+    mean_score: Optional[float] = None
+
+    pass_percentage: Optional[float] = None
+
+    std_score: Optional[float] = None
+
+
+class ResultsEvaluationScoreResults(BaseModel):
+    aggregated_scores: Optional[ResultsEvaluationScoreResultsAggregatedScores] = None
+
+    failed_samples: Optional[float] = None
+    """number of failed samples generated from model"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    invalid_score_count: Optional[float] = None
+    """number of invalid scores generated from model"""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+
+class ResultsEvaluationCompareResults(BaseModel):
+    a_wins: Optional[int] = FieldInfo(alias="A_wins", default=None)
+    """Number of times model A won"""
+
+    b_wins: Optional[int] = FieldInfo(alias="B_wins", default=None)
+    """Number of times model B won"""
+
+    generation_fail_count: Optional[float] = None
+    """Number of failed generations."""
+
+    judge_fail_count: Optional[float] = None
+    """Number of failed judge generations"""
+
+    num_samples: Optional[int] = None
+    """Total number of samples compared"""
+
+    result_file_id: Optional[str] = None
+    """Data File ID"""
+
+    ties: Optional[int] = FieldInfo(alias="Ties", default=None)
+    """Number of ties"""
+
+
+class ResultsError(BaseModel):
+    error: Optional[str] = None
+
+
+Results: TypeAlias = Union[
+    ResultsEvaluationClassifyResults, ResultsEvaluationScoreResults, ResultsEvaluationCompareResults, ResultsError, None
+]
+
+
+class StatusUpdate(BaseModel):
+    message: Optional[str] = None
+    """Additional message for this update"""
+
+    status: Optional[str] = None
+    """The status at this update"""
+
+    timestamp: Optional[datetime] = None
+    """When this update occurred"""
+
+
+class EvaluationJob(BaseModel):
+    created_at: Optional[datetime] = None
+    """When the job was created"""
+
+    owner_id: Optional[str] = None
+    """ID of the job owner (admin only)"""
+
+    parameters: Optional[Dict[str, object]] = None
+    """The parameters used for this evaluation"""
+
+    results: Optional[Results] = None
+    """Results of the evaluation (when completed)"""
+
+    status: Optional[Literal["pending", "queued", "running", "completed", "error", "user_error"]] = None
+    """Current status of the job"""
+
+    status_updates: Optional[List[StatusUpdate]] = None
+    """History of status updates (admin only)"""
+
+    type: Optional[Literal["classify", "score", "compare"]] = None
+    """The type of evaluation"""
+
+    updated_at: Optional[datetime] = None
+    """When the job was last updated"""
+
+    workflow_id: Optional[str] = None
+    """The evaluation job ID"""

together/types/execute_response.py

@@ -0,0 +1,108 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+
+__all__ = [
+    "ExecuteResponse",
+    "SuccessfulExecution",
+    "SuccessfulExecutionData",
+    "SuccessfulExecutionDataOutput",
+    "SuccessfulExecutionDataOutputStreamOutput",
+    "SuccessfulExecutionDataOutputError",
+    "SuccessfulExecutionDataOutputDisplayorExecuteOutput",
+    "SuccessfulExecutionDataOutputDisplayorExecuteOutputData",
+    "FailedExecution",
+]
+
+
+class SuccessfulExecutionDataOutputStreamOutput(BaseModel):
+    data: str
+
+    type: Literal["stdout", "stderr"]
+
+
+class SuccessfulExecutionDataOutputError(BaseModel):
+    data: str
+
+    type: Literal["error"]
+
+
+class SuccessfulExecutionDataOutputDisplayorExecuteOutputData(BaseModel):
+    application_geo_json: Optional[Dict[str, object]] = FieldInfo(alias="application/geo+json", default=None)
+
+    application_javascript: Optional[str] = FieldInfo(alias="application/javascript", default=None)
+
+    application_json: Optional[Dict[str, object]] = FieldInfo(alias="application/json", default=None)
+
+    application_pdf: Optional[str] = FieldInfo(alias="application/pdf", default=None)
+
+    application_vnd_vega_v5_json: Optional[Dict[str, object]] = FieldInfo(
+        alias="application/vnd.vega.v5+json", default=None
+    )
+
+    application_vnd_vegalite_v4_json: Optional[Dict[str, object]] = FieldInfo(
+        alias="application/vnd.vegalite.v4+json", default=None
+    )
+
+    image_gif: Optional[str] = FieldInfo(alias="image/gif", default=None)
+
+    image_jpeg: Optional[str] = FieldInfo(alias="image/jpeg", default=None)
+
+    image_png: Optional[str] = FieldInfo(alias="image/png", default=None)
+
+    image_svg_xml: Optional[str] = FieldInfo(alias="image/svg+xml", default=None)
+
+    text_html: Optional[str] = FieldInfo(alias="text/html", default=None)
+
+    text_latex: Optional[str] = FieldInfo(alias="text/latex", default=None)
+
+    text_markdown: Optional[str] = FieldInfo(alias="text/markdown", default=None)
+
+    text_plain: Optional[str] = FieldInfo(alias="text/plain", default=None)
+
+
+class SuccessfulExecutionDataOutputDisplayorExecuteOutput(BaseModel):
+    data: SuccessfulExecutionDataOutputDisplayorExecuteOutputData
+
+    type: Literal["display_data", "execute_result"]
+
+
+SuccessfulExecutionDataOutput: TypeAlias = Annotated[
+    Union[
+        SuccessfulExecutionDataOutputStreamOutput,
+        SuccessfulExecutionDataOutputError,
+        SuccessfulExecutionDataOutputDisplayorExecuteOutput,
+    ],
+    PropertyInfo(discriminator="type"),
+]
+
+
+class SuccessfulExecutionData(BaseModel):
+    outputs: List[SuccessfulExecutionDataOutput]
+
+    session_id: str
+    """Identifier of the current session. Used to make follow-up calls."""
+
+    status: Optional[Literal["success"]] = None
+    """Status of the execution. Currently only supports success."""
+
+
+class SuccessfulExecution(BaseModel):
+    data: SuccessfulExecutionData
+
+    errors: None = None
+
+
+class FailedExecution(BaseModel):
+    data: None = None
+
+    errors: List[Union[str, Dict[str, object]]]
+
+
+ExecuteResponse: TypeAlias = Union[SuccessfulExecution, FailedExecution]

together/types/file_delete_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["FileDeleteResponse"]
+
+
+class FileDeleteResponse(BaseModel):
+    id: Optional[str] = None
+
+    deleted: Optional[bool] = None

together/types/file_list.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .file_response import FileResponse
+
+__all__ = ["FileList"]
+
+
+class FileList(BaseModel):
+    data: List[FileResponse]

together/types/file_purpose.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["FilePurpose"]
+
+FilePurpose: TypeAlias = Literal[
+    "fine-tune", "eval", "eval-sample", "eval-output", "eval-summary", "batch-generated", "batch-api"
+]

together/types/file_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .file_type import FileType
+from .file_purpose import FilePurpose
+
+__all__ = ["FileResponse"]
+
+
+class FileResponse(BaseModel):
+    id: str
+
+    bytes: int
+
+    created_at: int
+
+    filename: str
+
+    file_type: FileType = FieldInfo(alias="FileType")
+    """The type of the file"""
+
+    line_count: int = FieldInfo(alias="LineCount")
+
+    object: str
+
+    processed: bool = FieldInfo(alias="Processed")
+
+    purpose: FilePurpose
+    """The purpose of the file"""

together/types/file_type.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["FileType"]
+
+FileType: TypeAlias = Literal["csv", "jsonl", "parquet"]

together/types/fine_tuning_cancel_response.py

@@ -0,0 +1,194 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .finetune_event import FinetuneEvent
+
+__all__ = [
+    "FineTuningCancelResponse",
+    "LrScheduler",
+    "LrSchedulerLrSchedulerArgs",
+    "LrSchedulerLrSchedulerArgsLinearLrSchedulerArgs",
+    "LrSchedulerLrSchedulerArgsCosineLrSchedulerArgs",
+    "TrainingMethod",
+    "TrainingMethodTrainingMethodSft",
+    "TrainingMethodTrainingMethodDpo",
+    "TrainingType",
+    "TrainingTypeFullTrainingType",
+    "TrainingTypeLoRaTrainingType",
+]
+
+
+class LrSchedulerLrSchedulerArgsLinearLrSchedulerArgs(BaseModel):
+    min_lr_ratio: Optional[float] = None
+    """The ratio of the final learning rate to the peak learning rate"""
+
+
+class LrSchedulerLrSchedulerArgsCosineLrSchedulerArgs(BaseModel):
+    min_lr_ratio: float
+    """The ratio of the final learning rate to the peak learning rate"""
+
+    num_cycles: float
+    """Number or fraction of cycles for the cosine learning rate scheduler"""
+
+
+LrSchedulerLrSchedulerArgs: TypeAlias = Union[
+    LrSchedulerLrSchedulerArgsLinearLrSchedulerArgs, LrSchedulerLrSchedulerArgsCosineLrSchedulerArgs
+]
+
+
+class LrScheduler(BaseModel):
+    lr_scheduler_type: Literal["linear", "cosine"]
+
+    lr_scheduler_args: Optional[LrSchedulerLrSchedulerArgs] = None
+
+
+class TrainingMethodTrainingMethodSft(BaseModel):
+    method: Literal["sft"]
+
+    train_on_inputs: Union[bool, Literal["auto"]]
+    """
+    Whether to mask the user messages in conversational data or prompts in
+    instruction data.
+    """
+
+
+class TrainingMethodTrainingMethodDpo(BaseModel):
+    method: Literal["dpo"]
+
+    dpo_beta: Optional[float] = None
+
+    dpo_normalize_logratios_by_length: Optional[bool] = None
+
+    dpo_reference_free: Optional[bool] = None
+
+    rpo_alpha: Optional[float] = None
+
+    simpo_gamma: Optional[float] = None
+
+
+TrainingMethod: TypeAlias = Union[TrainingMethodTrainingMethodSft, TrainingMethodTrainingMethodDpo]
+
+
+class TrainingTypeFullTrainingType(BaseModel):
+    type: Literal["Full"]
+
+
+class TrainingTypeLoRaTrainingType(BaseModel):
+    lora_alpha: int
+
+    lora_r: int
+
+    type: Literal["Lora"]
+
+    lora_dropout: Optional[float] = None
+
+    lora_trainable_modules: Optional[str] = None
+
+
+TrainingType: TypeAlias = Union[TrainingTypeFullTrainingType, TrainingTypeLoRaTrainingType]
+
+
+class FineTuningCancelResponse(BaseModel):
+    id: str
+    """Unique identifier for the fine-tune job"""
+
+    created_at: datetime
+    """Creation timestamp of the fine-tune job"""
+
+    status: Literal[
+        "pending",
+        "queued",
+        "running",
+        "compressing",
+        "uploading",
+        "cancel_requested",
+        "cancelled",
+        "error",
+        "completed",
+    ]
+
+    updated_at: datetime
+    """Last update timestamp of the fine-tune job"""
+
+    batch_size: Optional[int] = None
+    """Batch size used for training"""
+
+    events: Optional[List[FinetuneEvent]] = None
+    """Events related to this fine-tune job"""
+
+    from_checkpoint: Optional[str] = None
+    """Checkpoint used to continue training"""
+
+    from_hf_model: Optional[str] = None
+    """Hugging Face Hub repo to start training from"""
+
+    hf_model_revision: Optional[str] = None
+    """The revision of the Hugging Face Hub model to continue training from"""
+
+    learning_rate: Optional[float] = None
+    """Learning rate used for training"""
+
+    lr_scheduler: Optional[LrScheduler] = None
+    """Learning rate scheduler configuration"""
+
+    max_grad_norm: Optional[float] = None
+    """Maximum gradient norm for clipping"""
+
+    model: Optional[str] = None
+    """Base model used for fine-tuning"""
+
+    x_model_output_name: Optional[str] = FieldInfo(alias="model_output_name", default=None)
+
+    n_checkpoints: Optional[int] = None
+    """Number of checkpoints saved during training"""
+
+    n_epochs: Optional[int] = None
+    """Number of training epochs"""
+
+    n_evals: Optional[int] = None
+    """Number of evaluations during training"""
+
+    owner_address: Optional[str] = None
+    """Owner address information"""
+
+    suffix: Optional[str] = None
+    """Suffix added to the fine-tuned model name"""
+
+    token_count: Optional[int] = None
+    """Count of tokens processed"""
+
+    total_price: Optional[int] = None
+    """Total price for the fine-tuning job"""
+
+    training_file: Optional[str] = None
+    """File-ID of the training file"""
+
+    training_method: Optional[TrainingMethod] = None
+    """Method of training used"""
+
+    training_type: Optional[TrainingType] = None
+    """Type of training used (full or LoRA)"""
+
+    user_id: Optional[str] = None
+    """Identifier for the user who created the job"""
+
+    validation_file: Optional[str] = None
+    """File-ID of the validation file"""
+
+    wandb_name: Optional[str] = None
+    """Weights & Biases run name"""
+
+    wandb_project_name: Optional[str] = None
+    """Weights & Biases project name"""
+
+    warmup_ratio: Optional[float] = None
+    """Ratio of warmup steps"""
+
+    weight_decay: Optional[float] = None
+    """Weight decay value used"""

together/types/fine_tuning_content_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["FineTuningContentParams"]
+
+
+class FineTuningContentParams(TypedDict, total=False):
+    ft_id: Required[str]
+    """Fine-tune ID to download. A string that starts with `ft-`."""
+
+    checkpoint: Literal["merged", "adapter", "model_output_path"]
+    """Specifies checkpoint type to download - `merged` vs `adapter`.
+
+    This field is required if the checkpoint_step is not set.
+    """
+
+    checkpoint_step: int
+    """Specifies step number for checkpoint to download.
+
+    Ignores `checkpoint` value if set.
+    """

together/types/fine_tuning_delete_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["FineTuningDeleteParams"]
+
+
+class FineTuningDeleteParams(TypedDict, total=False):
+    force: bool

together/types/fine_tuning_delete_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["FineTuningDeleteResponse"]
+
+
+class FineTuningDeleteResponse(BaseModel):
+    message: Optional[str] = None
+    """Message indicating the result of the deletion"""

together/types/fine_tuning_list_checkpoints_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+
+__all__ = ["FineTuningListCheckpointsResponse", "Data"]
+
+
+class Data(BaseModel):
+    checkpoint_type: str
+
+    created_at: str
+
+    path: str
+
+    step: int
+
+
+class FineTuningListCheckpointsResponse(BaseModel):
+    data: List[Data]

together/types/fine_tuning_list_events_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .finetune_event import FinetuneEvent
+
+__all__ = ["FineTuningListEventsResponse"]
+
+
+class FineTuningListEventsResponse(BaseModel):
+    data: List[FinetuneEvent]