| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
OpenAI.V1.FineTuning.Jobs
Contents
Description
/v1/fine_tuning/jobs
Synopsis
- newtype FineTuningJobID = FineTuningJobID {}
- data CreateFineTuningJob = CreateFineTuningJob {
- model :: Model
- training_file :: FileID
- hyperparameters :: Maybe Hyperparameters
- suffix :: Maybe Text
- validation_file :: Maybe FileID
- integrations :: Maybe (Vector Integration)
- seed :: Maybe Integer
- _CreateFineTuningJob :: CreateFineTuningJob
- data JobObject = JobObject {
- id :: FineTuningJobID
- created_at :: POSIXTime
- error :: Maybe Error
- fine_tuned_model :: Maybe Model
- finished_at :: Maybe POSIXTime
- hyperparameters :: Hyperparameters
- model :: Model
- object :: Text
- organization_id :: Text
- result_files :: Vector FileID
- status :: Status
- trained_tokens :: Maybe Natural
- training_file :: FileID
- validation_file :: Maybe FileID
- integrations :: Maybe (Vector Integration)
- seed :: Integer
- estimated_finish :: Maybe POSIXTime
- data EventObject = EventObject {}
- data CheckpointObject = CheckpointObject {}
- data AutoOr a
- data Hyperparameters = Hyperparameters {}
- data WAndB = WAndB {}
- data Integration = Integration_WAndB {}
- data Status
- data Level
- data Metrics = Metrics {}
- type API = "fine_tuning" :> ("jobs" :> ((ReqBody '[JSON] CreateFineTuningJob :> Post '[JSON] JobObject) :<|> ((QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf JobObject))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("events" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf EventObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("checkpoints" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf CheckpointObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> Get '[JSON] JobObject) :<|> (Capture "fine_tuning_job_id" FineTuningJobID :> ("cancel" :> Post '[JSON] JobObject))))))))
Main types
newtype FineTuningJobID Source #
Fine tuning job ID
Constructors
| FineTuningJobID | |
Instances
data CreateFineTuningJob Source #
Request body for /v1/fine_tuning/jobs
Constructors
| CreateFineTuningJob | |
Fields
| |
Instances
The fine_tuning.job object represents a fine-tuning job that has been created through the API.
Constructors
| JobObject | |
Fields
| |
Instances
| FromJSON JobObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON JobObject Source # | |||||
| Generic JobObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show JobObject Source # | |||||
| type Rep JobObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep JobObject = D1 ('MetaData "JobObject" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "JobObject" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FineTuningJobID) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)) :*: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Error)) :*: S1 ('MetaSel ('Just "fine_tuned_model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Model)))) :*: ((S1 ('MetaSel ('Just "finished_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :*: S1 ('MetaSel ('Just "hyperparameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hyperparameters)) :*: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: (((S1 ('MetaSel ('Just "organization_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "result_files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector FileID))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "trained_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "training_file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "validation_file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileID))) :*: (S1 ('MetaSel ('Just "integrations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Integration))) :*: (S1 ('MetaSel ('Just "seed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "estimated_finish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)))))))) | |||||
data EventObject Source #
Fine-tuning job event object
Constructors
| EventObject | |
Instances
| FromJSON EventObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON EventObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods toJSON :: EventObject -> Value # toEncoding :: EventObject -> Encoding # toJSONList :: [EventObject] -> Value # toEncodingList :: [EventObject] -> Encoding # omitField :: EventObject -> Bool # | |||||
| Generic EventObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show EventObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods showsPrec :: Int -> EventObject -> ShowS # show :: EventObject -> String # showList :: [EventObject] -> ShowS # | |||||
| type Rep EventObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep EventObject = D1 ('MetaData "EventObject" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "EventObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)) :*: (S1 ('MetaSel ('Just "level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Level) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) | |||||
data CheckpointObject Source #
The fine_tuning.job.checkpoint object represents a model checkpoint for
a fine-tuning job that is ready to use
Constructors
| CheckpointObject | |
Fields
| |
Instances
| FromJSON CheckpointObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods parseJSON :: Value -> Parser CheckpointObject # parseJSONList :: Value -> Parser [CheckpointObject] # | |||||
| ToJSON CheckpointObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods toJSON :: CheckpointObject -> Value # toEncoding :: CheckpointObject -> Encoding # toJSONList :: [CheckpointObject] -> Value # toEncodingList :: [CheckpointObject] -> Encoding # omitField :: CheckpointObject -> Bool # | |||||
| Generic CheckpointObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
Methods from :: CheckpointObject -> Rep CheckpointObject x # to :: Rep CheckpointObject x -> CheckpointObject # | |||||
| Show CheckpointObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods showsPrec :: Int -> CheckpointObject -> ShowS # show :: CheckpointObject -> String # showList :: [CheckpointObject] -> ShowS # | |||||
| type Rep CheckpointObject Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep CheckpointObject = D1 ('MetaData "CheckpointObject" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CheckpointObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime) :*: S1 ('MetaSel ('Just "fine_tuned_model_checkpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "step_number") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metrics)) :*: (S1 ('MetaSel ('Just "fine_tuning_job_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FineTuningJobID) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) | |||||
Other types
A type that can also be the string "auto"
Instances
| FromJSON a => FromJSON (AutoOr a) Source # | |||||
Defined in OpenAI.V1.AutoOr | |||||
| ToJSON a => ToJSON (AutoOr a) Source # | |||||
| IsString a => IsString (AutoOr a) Source # | |||||
Defined in OpenAI.V1.AutoOr Methods fromString :: String -> AutoOr a # | |||||
| Generic (AutoOr a) Source # | |||||
Defined in OpenAI.V1.AutoOr Associated Types
| |||||
| Show a => Show (AutoOr a) Source # | |||||
| type Rep (AutoOr a) Source # | |||||
Defined in OpenAI.V1.AutoOr type Rep (AutoOr a) = D1 ('MetaData "AutoOr" "OpenAI.V1.AutoOr" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Specific" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))) | |||||
data Hyperparameters Source #
The hyperparameters used for the fine-tuning job
Constructors
| Hyperparameters | |
Instances
| FromJSON Hyperparameters Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods parseJSON :: Value -> Parser Hyperparameters # parseJSONList :: Value -> Parser [Hyperparameters] # | |||||
| ToJSON Hyperparameters Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods toJSON :: Hyperparameters -> Value # toEncoding :: Hyperparameters -> Encoding # toJSONList :: [Hyperparameters] -> Value # toEncodingList :: [Hyperparameters] -> Encoding # omitField :: Hyperparameters -> Bool # | |||||
| Generic Hyperparameters Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
Methods from :: Hyperparameters -> Rep Hyperparameters x # to :: Rep Hyperparameters x -> Hyperparameters # | |||||
| Show Hyperparameters Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods showsPrec :: Int -> Hyperparameters -> ShowS # show :: Hyperparameters -> String # showList :: [Hyperparameters] -> ShowS # | |||||
| type Rep Hyperparameters Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep Hyperparameters = D1 ('MetaData "Hyperparameters" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Hyperparameters" 'PrefixI 'True) (S1 ('MetaSel ('Just "batch_size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Natural))) :*: (S1 ('MetaSel ('Just "learning_rate_multiplier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Double))) :*: S1 ('MetaSel ('Just "n_epochs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Natural)))))) | |||||
The settings for your integration with Weights and
Constructors
| WAndB | |
Instances
| FromJSON WAndB Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON WAndB Source # | |||||
| Generic WAndB Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show WAndB Source # | |||||
| type Rep WAndB Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep WAndB = D1 ('MetaData "WAndB" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "WAndB" 'PrefixI 'True) ((S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "entity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))))) | |||||
data Integration Source #
An integration to enable for your fine-tuning job
Constructors
| Integration_WAndB | |
Instances
| FromJSON Integration Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON Integration Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods toJSON :: Integration -> Value # toEncoding :: Integration -> Encoding # toJSONList :: [Integration] -> Value # toEncodingList :: [Integration] -> Encoding # omitField :: Integration -> Bool # | |||||
| Generic Integration Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show Integration Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS # | |||||
| type Rep Integration Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep Integration = D1 ('MetaData "Integration" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Integration_WAndB" 'PrefixI 'True) (S1 ('MetaSel ('Just "wandb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WAndB))) | |||||
The current status of the fine-tuning job
Instances
| FromJSON Status Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON Status Source # | |||||
| Generic Status Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show Status Source # | |||||
| type Rep Status Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) ((C1 ('MetaCons "Validating_Files" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Queued" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Running" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Succeeded" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Failed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type)))) | |||||
Log level
Instances
| FromJSON Level Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON Level Source # | |||||
| Generic Level Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show Level Source # | |||||
| type Rep Level Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep Level = D1 ('MetaData "Level" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Warn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type))) | |||||
Metrics at the step number during the fine-tuning job.
Constructors
| Metrics | |
Instances
| FromJSON Metrics Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs | |||||
| ToJSON Metrics Source # | |||||
| Generic Metrics Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs Associated Types
| |||||
| Show Metrics Source # | |||||
| type Rep Metrics Source # | |||||
Defined in OpenAI.V1.FineTuning.Jobs type Rep Metrics = D1 ('MetaData "Metrics" "OpenAI.V1.FineTuning.Jobs" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Metrics" 'PrefixI 'True) ((S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "train_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "train_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: ((S1 ('MetaSel ('Just "valid_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "valid_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "full_valid_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "full_valid_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))) | |||||
Servant
type API = "fine_tuning" :> ("jobs" :> ((ReqBody '[JSON] CreateFineTuningJob :> Post '[JSON] JobObject) :<|> ((QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf JobObject))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("events" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf EventObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("checkpoints" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf CheckpointObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> Get '[JSON] JobObject) :<|> (Capture "fine_tuning_job_id" FineTuningJobID :> ("cancel" :> Post '[JSON] JobObject)))))))) Source #
Servant API