Sync changes in FineTuning API

src/main/java/io/github/sashirestela/openai/OpenAI.java

@@ -26,6 +26,7 @@
 import io.github.sashirestela.openai.domain.embedding.EncodingFormat;
 import io.github.sashirestela.openai.domain.file.FileRequest;
 import io.github.sashirestela.openai.domain.file.FileResponse;
+import io.github.sashirestela.openai.domain.finetuning.Checkpoint;
 import io.github.sashirestela.openai.domain.finetuning.FineTuningEvent;
 import io.github.sashirestela.openai.domain.finetuning.FineTuningRequest;
 import io.github.sashirestela.openai.domain.finetuning.FineTuningResponse;
@@ -390,6 +391,22 @@ default CompletableFuture<List<FineTuningEvent>> getEvents(String fineTuningId,
         CompletableFuture<OpenAIGeneric<FineTuningEvent>> getEventsRoot(@Path("fineTuningId") String fineTuningId,
                 @Query("limit") Integer limit, @Query("after") String after);
 
+        /**
+         * List checkpoints for a fine-tuning job.
+         * 
+         * @param fineTuningId The id of the fine-tuning job to get checkpoints for.
+         * @param limit        Number of fine-tuning jobs to retrieve.
+         * @param after        Identifier for the last job from the previous pagination request.
+         * @return A list of fine-tuning checkpoint objects.
+         */
+        default CompletableFuture<List<Checkpoint>> getCheckpoints(String fineTuningId, Integer limit, String after) {
+            return getCheckpointsRoot(fineTuningId, limit, after).thenApply(OpenAIGeneric::getData);
+        }
+
+        @GET("/{fineTuningId}/checkpoints")
+        CompletableFuture<OpenAIGeneric<Checkpoint>> getCheckpointsRoot(@Path("fineTuningId") String fineTuningId,
+                @Query("limit") Integer limit, @Query("after") String after);
+
         /**
          * Immediately cancel a fine-tune job.
          * 

src/main/java/io/github/sashirestela/openai/domain/finetuning/Checkpoint.java

@@ -0,0 +1,23 @@
+package io.github.sashirestela.openai.domain.finetuning;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@NoArgsConstructor
+@Getter
+@ToString
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public class Checkpoint {
+
+    private String id;
+    private Integer createdAt;
+    private String fineTunedModelCheckpoint;
+    private Integer stepNumber;
+    private Metrics metrics;
+    private String fineTuningJobId;
+    private String object;
+
+}

src/main/java/io/github/sashirestela/openai/domain/finetuning/FineTuningRequest.java

@@ -7,6 +7,9 @@
 import io.github.sashirestela.slimvalidator.constraints.Required;
 import lombok.Builder;
 import lombok.Getter;
+import lombok.Singular;
+
+import java.util.List;
 
 @Getter
 @Builder
@@ -26,4 +29,9 @@ public class FineTuningRequest {
 
     private String suffix;
 
+    @Singular
+    private List<Integration> integrations;
+
+    private Integer seed;
+
 }

src/main/java/io/github/sashirestela/openai/domain/finetuning/FineTuningResponse.java

@@ -28,5 +28,7 @@ public class FineTuningResponse {
     private List<String> resultFiles;
     private Integer trainedTokens;
     private FineTuningError error;
+    private List<Integration> integrations;
+    private Integer seed;
 
 }

src/main/java/io/github/sashirestela/openai/domain/finetuning/Integration.java

@@ -0,0 +1,27 @@
+package io.github.sashirestela.openai.domain.finetuning;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import io.github.sashirestela.slimvalidator.constraints.Required;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Getter
+@Builder
+@JsonInclude(Include.NON_EMPTY)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public class Integration {
+
+    @Required
+    private IntegrationType type;
+
+    @Required
+    private WandbIntegration wandb;
+
+}

src/main/java/io/github/sashirestela/openai/domain/finetuning/IntegrationType.java

@@ -0,0 +1,10 @@
+package io.github.sashirestela.openai.domain.finetuning;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public enum IntegrationType {
+
+    @JsonProperty("wandb")
+    WANDB;
+
+}

src/main/java/io/github/sashirestela/openai/domain/finetuning/Metrics.java

@@ -0,0 +1,23 @@
+package io.github.sashirestela.openai.domain.finetuning;
+
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
+@NoArgsConstructor
+@Getter
+@ToString
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public class Metrics {
+
+    private Double step;
+    private Double trainLoss;
+    private Double trainMeanTokenAccuracy;
+    private Double validLoss;
+    private Double validMeanTokenAccuracy;
+    private Double fullValidLoss;
+    private Double fullValidMeanTokenAccuracy;
+
+}

src/main/java/io/github/sashirestela/openai/domain/finetuning/WandbIntegration.java

@@ -0,0 +1,34 @@
+package io.github.sashirestela.openai.domain.finetuning;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import io.github.sashirestela.slimvalidator.constraints.Required;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Singular;
+
+import java.util.List;
+
+@NoArgsConstructor
+@AllArgsConstructor
+@Getter
+@Builder
+@JsonInclude(Include.NON_EMPTY)
+@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
+public class WandbIntegration {
+
+    @Required
+    private String project;
+
+    private String name;
+
+    private String entity;
+
+    @Singular
+    private List<String> tags;
+
+}

src/test/java/io/github/sashirestela/openai/domain/finetuning/FineTuningDomainTest.java

@@ -38,6 +38,17 @@ void testFineTuningsCreate() throws IOException {
                         .nEpochs("auto")
                         .build())
                 .suffix("suffix")
+                .integration(Integration.builder()
+                        .type(IntegrationType.WANDB)
+                        .wandb(WandbIntegration.builder()
+                                .project("my-wandb-project")
+                                .name("ft-run-display-name")
+                                .entity("testing")
+                                .tag("first-experiment")
+                                .tag("v2")
+                                .build())
+                        .build())
+                .seed(99)
                 .build();
         var fineTuningResponse = openAI.fineTunings().create(fineTuningRequest).join();
         System.out.println(fineTuningResponse);
@@ -68,6 +79,14 @@ void testFineTuningsGetEvents() throws IOException {
         assertNotNull(fineTuningResponse);
     }
 
+    @Test
+    void testFineTuningsGetCheckpoints() throws IOException {
+        DomainTestingHelper.get().mockForObject(httpClient, "src/test/resources/finetunings_getcheckpoints.json");
+        var fineTuningResponse = openAI.fineTunings().getCheckpoints("finetuningId", 2, null).join();
+        System.out.println(fineTuningResponse);
+        assertNotNull(fineTuningResponse);
+    }
+
     @Test
     void testFineTuningsCancel() throws IOException {
         DomainTestingHelper.get().mockForObject(httpClient, "src/test/resources/finetunings_cancel.json");

src/test/resources/finetunings_create.json

@@ -1 +1 @@
-{ "object": "fine_tuning.job", "id": "ftjob-35j8EBrZVsuyFFe2OD8Tkmvd", "model": "gpt-3.5-turbo-1106", "created_at": 1700533111, "finished_at": null, "fine_tuned_model": null, "organization_id": "org-4WdgDKZ75eLPEH6zqX5hFd5e", "result_files": [], "status": "validating_files", "validation_file": null, "training_file": "file-0e5BDWQYA1KsguTJRCCXqAa2", "hyperparameters": { "n_epochs": "auto", "batch_size": "auto", "learning_rate_multiplier": "auto" }, "trained_tokens": null, "error": null }
+{ "object": "fine_tuning.job", "id": "ftjob-35j8EBrZVsuyFFe2OD8Tkmvd", "model": "gpt-3.5-turbo-1106", "created_at": 1700533111, "finished_at": null, "fine_tuned_model": null, "organization_id": "org-4WdgDKZ75eLPEH6zqX5hFd5e", "result_files": [], "status": "validating_files", "validation_file": null, "training_file": "file-0e5BDWQYA1KsguTJRCCXqAa2", "hyperparameters": { "n_epochs": "auto", "batch_size": "auto", "learning_rate_multiplier": "auto" }, "trained_tokens": null, "error": null, "integrations":[{"type":"wandb","wandb":{"project":"my-wandb-project","name":"ft-run-display-name","tags":["first-experiment","v2"]}}], "seed": 99 }

src/test/resources/finetunings_getcheckpoints.json

@@ -0,0 +1 @@
+{"object":"list","data":[{"object":"fine_tuning.job.checkpoint","id":"ftckpt_zc4Q7MP6XxulcVzj4MZdwsAB","created_at":1519129973,"fine_tuned_model_checkpoint":"ft:gpt-3.5-turbo-0125:my-org:custom-suffix:96olL566:ckpt-step-2000","metrics":{"full_valid_loss":0.134,"full_valid_mean_token_accuracy":0.874},"fine_tuning_job_id":"ftjob-abc123","step_number":2000},{"object":"fine_tuning.job.checkpoint","id":"ftckpt_enQCFmOTGj3syEpYVhBRLTSy","created_at":1519129833,"fine_tuned_model_checkpoint":"ft:gpt-3.5-turbo-0125:my-org:custom-suffix:7q8mpxmy:ckpt-step-1000","metrics":{"full_valid_loss":0.167,"full_valid_mean_token_accuracy":0.781},"fine_tuning_job_id":"ftjob-abc123","step_number":1000}],"first_id":"ftckpt_zc4Q7MP6XxulcVzj4MZdwsAB","last_id":"ftckpt_enQCFmOTGj3syEpYVhBRLTSy","has_more":true}