modelmix 1.0.2

package/demo/node_modules/openai/src/resources/fine-tuning/fine-tuning.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as JobsAPI from './jobs/jobs';
+
+export class FineTuning extends APIResource {
+  jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
+}
+
+export namespace FineTuning {
+  export import Jobs = JobsAPI.Jobs;
+  export import FineTuningJob = JobsAPI.FineTuningJob;
+  export import FineTuningJobEvent = JobsAPI.FineTuningJobEvent;
+  export import FineTuningJobIntegration = JobsAPI.FineTuningJobIntegration;
+  export import FineTuningJobWandbIntegration = JobsAPI.FineTuningJobWandbIntegration;
+  export import FineTuningJobWandbIntegrationObject = JobsAPI.FineTuningJobWandbIntegrationObject;
+  export import FineTuningJobsPage = JobsAPI.FineTuningJobsPage;
+  export import FineTuningJobEventsPage = JobsAPI.FineTuningJobEventsPage;
+  export import JobCreateParams = JobsAPI.JobCreateParams;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobListEventsParams = JobsAPI.JobListEventsParams;
+}

package/demo/node_modules/openai/src/resources/fine-tuning/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { FineTuning } from './fine-tuning';
+export {
+  FineTuningJob,
+  FineTuningJobEvent,
+  FineTuningJobIntegration,
+  FineTuningJobWandbIntegration,
+  FineTuningJobWandbIntegrationObject,
+  JobCreateParams,
+  JobListParams,
+  JobListEventsParams,
+  FineTuningJobsPage,
+  FineTuningJobEventsPage,
+  Jobs,
+} from './jobs/index';

package/demo/node_modules/openai/src/resources/fine-tuning/jobs/checkpoints.ts

@@ -0,0 +1,108 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as CheckpointsAPI from './checkpoints';
+import { CursorPage, type CursorPageParams } from '../../../pagination';
+
+export class Checkpoints extends APIResource {
+  /**
+   * List checkpoints for a fine-tuning job.
+   */
+  list(
+    fineTuningJobId: string,
+    query?: CheckpointListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobCheckpointsPage, FineTuningJobCheckpoint>;
+  list(
+    fineTuningJobId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobCheckpointsPage, FineTuningJobCheckpoint>;
+  list(
+    fineTuningJobId: string,
+    query: CheckpointListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobCheckpointsPage, FineTuningJobCheckpoint> {
+    if (isRequestOptions(query)) {
+      return this.list(fineTuningJobId, {}, query);
+    }
+    return this._client.getAPIList(
+      `/fine_tuning/jobs/${fineTuningJobId}/checkpoints`,
+      FineTuningJobCheckpointsPage,
+      { query, ...options },
+    );
+  }
+}
+
+export class FineTuningJobCheckpointsPage extends CursorPage<FineTuningJobCheckpoint> {}
+
+/**
+ * The `fine_tuning.job.checkpoint` object represents a model checkpoint for a
+ * fine-tuning job that is ready to use.
+ */
+export interface FineTuningJobCheckpoint {
+  /**
+   * The checkpoint identifier, which can be referenced in the API endpoints.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the checkpoint was created.
+   */
+  created_at: number;
+
+  /**
+   * The name of the fine-tuned checkpoint model that is created.
+   */
+  fine_tuned_model_checkpoint: string;
+
+  /**
+   * The name of the fine-tuning job that this checkpoint was created from.
+   */
+  fine_tuning_job_id: string;
+
+  /**
+   * Metrics at the step number during the fine-tuning job.
+   */
+  metrics: FineTuningJobCheckpoint.Metrics;
+
+  /**
+   * The object type, which is always "fine_tuning.job.checkpoint".
+   */
+  object: 'fine_tuning.job.checkpoint';
+
+  /**
+   * The step number that the checkpoint was created at.
+   */
+  step_number: number;
+}
+
+export namespace FineTuningJobCheckpoint {
+  /**
+   * Metrics at the step number during the fine-tuning job.
+   */
+  export interface Metrics {
+    full_valid_loss?: number;
+
+    full_valid_mean_token_accuracy?: number;
+
+    step?: number;
+
+    train_loss?: number;
+
+    train_mean_token_accuracy?: number;
+
+    valid_loss?: number;
+
+    valid_mean_token_accuracy?: number;
+  }
+}
+
+export interface CheckpointListParams extends CursorPageParams {}
+
+export namespace Checkpoints {
+  export import FineTuningJobCheckpoint = CheckpointsAPI.FineTuningJobCheckpoint;
+  export import FineTuningJobCheckpointsPage = CheckpointsAPI.FineTuningJobCheckpointsPage;
+  export import CheckpointListParams = CheckpointsAPI.CheckpointListParams;
+}

package/demo/node_modules/openai/src/resources/fine-tuning/jobs/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  FineTuningJob,
+  FineTuningJobEvent,
+  FineTuningJobIntegration,
+  FineTuningJobWandbIntegration,
+  FineTuningJobWandbIntegrationObject,
+  JobCreateParams,
+  JobListParams,
+  JobListEventsParams,
+  FineTuningJobsPage,
+  FineTuningJobEventsPage,
+  Jobs,
+} from './jobs';
+export {
+  FineTuningJobCheckpoint,
+  CheckpointListParams,
+  FineTuningJobCheckpointsPage,
+  Checkpoints,
+} from './checkpoints';

package/demo/node_modules/openai/src/resources/fine-tuning/jobs/jobs.ts

@@ -0,0 +1,458 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as JobsAPI from './jobs';
+import * as CheckpointsAPI from './checkpoints';
+import { CursorPage, type CursorPageParams } from '../../../pagination';
+
+export class Jobs extends APIResource {
+  checkpoints: CheckpointsAPI.Checkpoints = new CheckpointsAPI.Checkpoints(this._client);
+
+  /**
+   * Creates a fine-tuning job which begins the process of creating a new model from
+   * a given dataset.
+   *
+   * Response includes details of the enqueued job including job status and the name
+   * of the fine-tuned models once complete.
+   *
+   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+   */
+  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this._client.post('/fine_tuning/jobs', { body, ...options });
+  }
+
+  /**
+   * Get info about a fine-tuning job.
+   *
+   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+   */
+  retrieve(fineTuningJobId: string, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this._client.get(`/fine_tuning/jobs/${fineTuningJobId}`, options);
+  }
+
+  /**
+   * List your organization's fine-tuning jobs
+   */
+  list(
+    query?: JobListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobsPage, FineTuningJob>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FineTuningJobsPage, FineTuningJob>;
+  list(
+    query: JobListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobsPage, FineTuningJob> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/fine_tuning/jobs', FineTuningJobsPage, { query, ...options });
+  }
+
+  /**
+   * Immediately cancel a fine-tune job.
+   */
+  cancel(fineTuningJobId: string, options?: Core.RequestOptions): Core.APIPromise<FineTuningJob> {
+    return this._client.post(`/fine_tuning/jobs/${fineTuningJobId}/cancel`, options);
+  }
+
+  /**
+   * Get status updates for a fine-tuning job.
+   */
+  listEvents(
+    fineTuningJobId: string,
+    query?: JobListEventsParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>;
+  listEvents(
+    fineTuningJobId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent>;
+  listEvents(
+    fineTuningJobId: string,
+    query: JobListEventsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FineTuningJobEventsPage, FineTuningJobEvent> {
+    if (isRequestOptions(query)) {
+      return this.listEvents(fineTuningJobId, {}, query);
+    }
+    return this._client.getAPIList(`/fine_tuning/jobs/${fineTuningJobId}/events`, FineTuningJobEventsPage, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export class FineTuningJobsPage extends CursorPage<FineTuningJob> {}
+
+export class FineTuningJobEventsPage extends CursorPage<FineTuningJobEvent> {}
+
+/**
+ * The `fine_tuning.job` object represents a fine-tuning job that has been created
+ * through the API.
+ */
+export interface FineTuningJob {
+  /**
+   * The object identifier, which can be referenced in the API endpoints.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the fine-tuning job was created.
+   */
+  created_at: number;
+
+  /**
+   * For fine-tuning jobs that have `failed`, this will contain more information on
+   * the cause of the failure.
+   */
+  error: FineTuningJob.Error | null;
+
+  /**
+   * The name of the fine-tuned model that is being created. The value will be null
+   * if the fine-tuning job is still running.
+   */
+  fine_tuned_model: string | null;
+
+  /**
+   * The Unix timestamp (in seconds) for when the fine-tuning job was finished. The
+   * value will be null if the fine-tuning job is still running.
+   */
+  finished_at: number | null;
+
+  /**
+   * The hyperparameters used for the fine-tuning job. See the
+   * [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning) for
+   * more details.
+   */
+  hyperparameters: FineTuningJob.Hyperparameters;
+
+  /**
+   * The base model that is being fine-tuned.
+   */
+  model: string;
+
+  /**
+   * The object type, which is always "fine_tuning.job".
+   */
+  object: 'fine_tuning.job';
+
+  /**
+   * The organization that owns the fine-tuning job.
+   */
+  organization_id: string;
+
+  /**
+   * The compiled results file ID(s) for the fine-tuning job. You can retrieve the
+   * results with the
+   * [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+   */
+  result_files: Array<string>;
+
+  /**
+   * The seed used for the fine-tuning job.
+   */
+  seed: number;
+
+  /**
+   * The current status of the fine-tuning job, which can be either
+   * `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.
+   */
+  status: 'validating_files' | 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled';
+
+  /**
+   * The total number of billable tokens processed by this fine-tuning job. The value
+   * will be null if the fine-tuning job is still running.
+   */
+  trained_tokens: number | null;
+
+  /**
+   * The file ID used for training. You can retrieve the training data with the
+   * [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+   */
+  training_file: string;
+
+  /**
+   * The file ID used for validation. You can retrieve the validation results with
+   * the
+   * [Files API](https://platform.openai.com/docs/api-reference/files/retrieve-contents).
+   */
+  validation_file: string | null;
+
+  /**
+   * The Unix timestamp (in seconds) for when the fine-tuning job is estimated to
+   * finish. The value will be null if the fine-tuning job is not running.
+   */
+  estimated_finish?: number | null;
+
+  /**
+   * A list of integrations to enable for this fine-tuning job.
+   */
+  integrations?: Array<FineTuningJobWandbIntegrationObject> | null;
+}
+
+export namespace FineTuningJob {
+  /**
+   * For fine-tuning jobs that have `failed`, this will contain more information on
+   * the cause of the failure.
+   */
+  export interface Error {
+    /**
+     * A machine-readable error code.
+     */
+    code: string;
+
+    /**
+     * A human-readable error message.
+     */
+    message: string;
+
+    /**
+     * The parameter that was invalid, usually `training_file` or `validation_file`.
+     * This field will be null if the failure was not parameter-specific.
+     */
+    param: string | null;
+  }
+
+  /**
+   * The hyperparameters used for the fine-tuning job. See the
+   * [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning) for
+   * more details.
+   */
+  export interface Hyperparameters {
+    /**
+     * The number of epochs to train the model for. An epoch refers to one full cycle
+     * through the training dataset. "auto" decides the optimal number of epochs based
+     * on the size of the dataset. If setting the number manually, we support any
+     * number between 1 and 50 epochs.
+     */
+    n_epochs: 'auto' | number;
+  }
+}
+
+/**
+ * Fine-tuning job event object
+ */
+export interface FineTuningJobEvent {
+  id: string;
+
+  created_at: number;
+
+  level: 'info' | 'warn' | 'error';
+
+  message: string;
+
+  object: 'fine_tuning.job.event';
+}
+
+export type FineTuningJobIntegration = FineTuningJobWandbIntegrationObject;
+
+/**
+ * The settings for your integration with Weights and Biases. This payload
+ * specifies the project that metrics will be sent to. Optionally, you can set an
+ * explicit display name for your run, add tags to your run, and set a default
+ * entity (team, username, etc) to be associated with your run.
+ */
+export interface FineTuningJobWandbIntegration {
+  /**
+   * The name of the project that the new run will be created under.
+   */
+  project: string;
+
+  /**
+   * The entity to use for the run. This allows you to set the team or username of
+   * the WandB user that you would like associated with the run. If not set, the
+   * default entity for the registered WandB API key is used.
+   */
+  entity?: string | null;
+
+  /**
+   * A display name to set for the run. If not set, we will use the Job ID as the
+   * name.
+   */
+  name?: string | null;
+
+  /**
+   * A list of tags to be attached to the newly created run. These tags are passed
+   * through directly to WandB. Some default tags are generated by OpenAI:
+   * "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".
+   */
+  tags?: Array<string>;
+}
+
+export interface FineTuningJobWandbIntegrationObject {
+  /**
+   * The type of the integration being enabled for the fine-tuning job
+   */
+  type: 'wandb';
+
+  /**
+   * The settings for your integration with Weights and Biases. This payload
+   * specifies the project that metrics will be sent to. Optionally, you can set an
+   * explicit display name for your run, add tags to your run, and set a default
+   * entity (team, username, etc) to be associated with your run.
+   */
+  wandb: FineTuningJobWandbIntegration;
+}
+
+export interface JobCreateParams {
+  /**
+   * The name of the model to fine-tune. You can select one of the
+   * [supported models](https://platform.openai.com/docs/guides/fine-tuning/what-models-can-be-fine-tuned).
+   */
+  model: (string & {}) | 'babbage-002' | 'davinci-002' | 'gpt-3.5-turbo';
+
+  /**
+   * The ID of an uploaded file that contains training data.
+   *
+   * See [upload file](https://platform.openai.com/docs/api-reference/files/create)
+   * for how to upload a file.
+   *
+   * Your dataset must be formatted as a JSONL file. Additionally, you must upload
+   * your file with the purpose `fine-tune`.
+   *
+   * See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+   * for more details.
+   */
+  training_file: string;
+
+  /**
+   * The hyperparameters used for the fine-tuning job.
+   */
+  hyperparameters?: JobCreateParams.Hyperparameters;
+
+  /**
+   * A list of integrations to enable for your fine-tuning job.
+   */
+  integrations?: Array<JobCreateParams.Integration> | null;
+
+  /**
+   * The seed controls the reproducibility of the job. Passing in the same seed and
+   * job parameters should produce the same results, but may differ in rare cases. If
+   * a seed is not specified, one will be generated for you.
+   */
+  seed?: number | null;
+
+  /**
+   * A string of up to 18 characters that will be added to your fine-tuned model
+   * name.
+   *
+   * For example, a `suffix` of "custom-model-name" would produce a model name like
+   * `ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.
+   */
+  suffix?: string | null;
+
+  /**
+   * The ID of an uploaded file that contains validation data.
+   *
+   * If you provide this file, the data is used to generate validation metrics
+   * periodically during fine-tuning. These metrics can be viewed in the fine-tuning
+   * results file. The same data should not be present in both train and validation
+   * files.
+   *
+   * Your dataset must be formatted as a JSONL file. You must upload your file with
+   * the purpose `fine-tune`.
+   *
+   * See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+   * for more details.
+   */
+  validation_file?: string | null;
+}
+
+export namespace JobCreateParams {
+  /**
+   * The hyperparameters used for the fine-tuning job.
+   */
+  export interface Hyperparameters {
+    /**
+     * Number of examples in each batch. A larger batch size means that model
+     * parameters are updated less frequently, but with lower variance.
+     */
+    batch_size?: 'auto' | number;
+
+    /**
+     * Scaling factor for the learning rate. A smaller learning rate may be useful to
+     * avoid overfitting.
+     */
+    learning_rate_multiplier?: 'auto' | number;
+
+    /**
+     * The number of epochs to train the model for. An epoch refers to one full cycle
+     * through the training dataset.
+     */
+    n_epochs?: 'auto' | number;
+  }
+
+  export interface Integration {
+    /**
+     * The type of integration to enable. Currently, only "wandb" (Weights and Biases)
+     * is supported.
+     */
+    type: 'wandb';
+
+    /**
+     * The settings for your integration with Weights and Biases. This payload
+     * specifies the project that metrics will be sent to. Optionally, you can set an
+     * explicit display name for your run, add tags to your run, and set a default
+     * entity (team, username, etc) to be associated with your run.
+     */
+    wandb: Integration.Wandb;
+  }
+
+  export namespace Integration {
+    /**
+     * The settings for your integration with Weights and Biases. This payload
+     * specifies the project that metrics will be sent to. Optionally, you can set an
+     * explicit display name for your run, add tags to your run, and set a default
+     * entity (team, username, etc) to be associated with your run.
+     */
+    export interface Wandb {
+      /**
+       * The name of the project that the new run will be created under.
+       */
+      project: string;
+
+      /**
+       * The entity to use for the run. This allows you to set the team or username of
+       * the WandB user that you would like associated with the run. If not set, the
+       * default entity for the registered WandB API key is used.
+       */
+      entity?: string | null;
+
+      /**
+       * A display name to set for the run. If not set, we will use the Job ID as the
+       * name.
+       */
+      name?: string | null;
+
+      /**
+       * A list of tags to be attached to the newly created run. These tags are passed
+       * through directly to WandB. Some default tags are generated by OpenAI:
+       * "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".
+       */
+      tags?: Array<string>;
+    }
+  }
+}
+
+export interface JobListParams extends CursorPageParams {}
+
+export interface JobListEventsParams extends CursorPageParams {}
+
+export namespace Jobs {
+  export import FineTuningJob = JobsAPI.FineTuningJob;
+  export import FineTuningJobEvent = JobsAPI.FineTuningJobEvent;
+  export import FineTuningJobIntegration = JobsAPI.FineTuningJobIntegration;
+  export import FineTuningJobWandbIntegration = JobsAPI.FineTuningJobWandbIntegration;
+  export import FineTuningJobWandbIntegrationObject = JobsAPI.FineTuningJobWandbIntegrationObject;
+  export import FineTuningJobsPage = JobsAPI.FineTuningJobsPage;
+  export import FineTuningJobEventsPage = JobsAPI.FineTuningJobEventsPage;
+  export import JobCreateParams = JobsAPI.JobCreateParams;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobListEventsParams = JobsAPI.JobListEventsParams;
+  export import Checkpoints = CheckpointsAPI.Checkpoints;
+  export import FineTuningJobCheckpoint = CheckpointsAPI.FineTuningJobCheckpoint;
+  export import FineTuningJobCheckpointsPage = CheckpointsAPI.FineTuningJobCheckpointsPage;
+  export import CheckpointListParams = CheckpointsAPI.CheckpointListParams;
+}