Fine-Tunes

The FineTunes class is defined in fine_tunes.h at liboai::FineTunes, and its interface can ideally be accessed through a liboai::OpenAI object.

This class and its associated liboai::OpenAI interface allow access to the Fine-tunes endpoint of the OpenAI API; this endpoint's functionality can be found below.

• Manage fine-tuning jobs to tailor a model to your specific training data.

Methods

This document covers the method(s) located in fine_tunes.h. You can find their function signature(s) below.

Create a Fine-Tune

Creates a job that fine-tunes a specified model from a given dataset. Returns a liboai::Response containing response data.

liboai::Response create(
  const std::string& training_file,
  std::optional<std::string> validation_file = std::nullopt,
  std::optional<std::string> model_id = std::nullopt,
  std::optional<uint8_t> n_epochs = std::nullopt,
  std::optional<uint16_t> batch_size = std::nullopt,
  std::optional<float> learning_rate_multiplier = std::nullopt,
  std::optional<float> prompt_loss_weight = std::nullopt,
  std::optional<bool> compute_classification_metrics = std::nullopt,
  std::optional<uint16_t> classification_n_classes = std::nullopt,
  std::optional<std::string> classification_positive_class = std::nullopt,
  std::optional<std::vector<float>> classification_betas = std::nullopt,
  std::optional<std::string> suffix = std::nullopt
) const & noexcept(false);

Create a Fine-Tune (async)

Asynchronously creates a job that fine-tunes a specified model from a given dataset. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse create_async(
  const std::string& training_file,
  std::optional<std::string> validation_file = std::nullopt,
  std::optional<std::string> model_id = std::nullopt,
  std::optional<uint8_t> n_epochs = std::nullopt,
  std::optional<uint16_t> batch_size = std::nullopt,
  std::optional<float> learning_rate_multiplier = std::nullopt,
  std::optional<float> prompt_loss_weight = std::nullopt,
  std::optional<bool> compute_classification_metrics = std::nullopt,
  std::optional<uint16_t> classification_n_classes = std::nullopt,
  std::optional<std::string> classification_positive_class = std::nullopt,
  std::optional<std::vector<float>> classification_betas = std::nullopt,
  std::optional<std::string> suffix = std::nullopt
) const & noexcept(false);

List Fine-Tunes

List your organization's fine-tuning jobs. Returns a liboai::Response containing response data.

liboai::Response list() const & noexcept(false);

List Fine-Tunes (async)

Asynchronously list your organization's fine-tuning jobs. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse list_async() const & noexcept(false);

Retrieve Fine-Tune

Gets info about the fine-tune job. Returns a liboai::Response containing response data.

liboai::Response retrieve(
  const std::string& fine_tune_id
) const & noexcept(false);

Retrieve Fine-Tune (async)

Asynchronously gets info about the fine-tune job. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse retrieve_async(
  const std::string& fine_tune_id
) const & noexcept(false);

Cancel Fine-Tune

Immediately cancel a fine-tune job. Returns a liboai::Response containing response data.

liboai::Response cancel(
  const std::string& fine_tune_id
) const & noexcept(false);

Cancel Fine-Tune (async)

Asynchronously and immediately cancel a fine-tune job. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse cancel_async(
  const std::string& fine_tune_id
) const & noexcept(false);

List Fine-Tune Events

Get fine-grained status updates for a fine-tune job. Returns a liboai::Response containing response data.

liboai::Response list_events(
  const std::string& fine_tune_id,
  std::optional<std::function<bool(std::string, intptr_t)>> stream = std::nullopt
) const & noexcept(false);

List Fine-Tune Events (async)

Asynchronously get fine-grained status updates for a fine-tune job. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse list_events_async(
  const std::string& fine_tune_id,
  std::optional<std::function<bool(std::string, intptr_t)>> stream = std::nullopt
) const & noexcept(false);

Delete Fine-Tune Model

Delete a fine-tuned model. You must have the Owner role in your organization. Returns a liboai::Response containing response data.

liboai::Response remove(
  const std::string& model
) const & noexcept(false);

Delete Fine-Tune Model (async)

Asynchronously delete a fine-tuned model. You must have the Owner role in your organization. Returns a liboai::FutureResponse containing future response data.

liboai::FutureResponse remove_async(
  const std::string& model
) const & noexcept(false);

All function parameters marked optional are not required and are resolved on OpenAI's end if not supplied.

Example Usage

For example usage of the above function(s), please refer to the examples folder.