create fine-tuning example

Author: simonpfish

examples/fine-tuning-data.jsonl

@@ -0,0 +1,10 @@
+{"messages": [{"role": "system", "content": "<system message 1>"}, {"role": "user", "content": "<user message 1>"}, {"role": "assistant", "content": "<example desired response 1>"}]}
+{"messages": [{"role": "system", "content": "<system message 2>"}, {"role": "user", "content": "<user message 2>"}, {"role": "assistant", "content": "<example desired response 2>"}]}
+{"messages": [{"role": "system", "content": "<system message 3>"}, {"role": "user", "content": "<user message 3>"}, {"role": "assistant", "content": "<example desired response 3>"}]}
+{"messages": [{"role": "system", "content": "<system message 4>"}, {"role": "user", "content": "<user message 4>"}, {"role": "assistant", "content": "<example desired response 4>"}]}
+{"messages": [{"role": "system", "content": "<system message 5>"}, {"role": "user", "content": "<user message 5>"}, {"role": "assistant", "content": "<example desired response 5>"}]}
+{"messages": [{"role": "system", "content": "<system message 6>"}, {"role": "user", "content": "<user message 6>"}, {"role": "assistant", "content": "<example desired response 6>"}]}
+{"messages": [{"role": "system", "content": "<system message 7>"}, {"role": "user", "content": "<user message 7>"}, {"role": "assistant", "content": "<example desired response 7>"}]}
+{"messages": [{"role": "system", "content": "<system message 8>"}, {"role": "user", "content": "<user message 8>"}, {"role": "assistant", "content": "<example desired response 8>"}]}
+{"messages": [{"role": "system", "content": "<system message 9>"}, {"role": "user", "content": "<user message 9>"}, {"role": "assistant", "content": "<example desired response 9>"}]}
+{"messages": [{"role": "system", "content": "<system message 10>"}, {"role": "user", "content": "<user message 10>"}, {"role": "assistant", "content": "<example desired response 10>"}]}

examples/fine-tuning.ts

@@ -0,0 +1,71 @@
+#!/usr/bin/env -S npm run tsn -T
+
+/**
+ * Fine-tuning allows you to train models on your own data.
+ *
+ * See these guides for more information:
+ * - https://help.openai.com/en/articles/5528730-fine-tuning-a-classifier-to-improve-truthfulness
+ * - https://platform.openai.com/docs/guides/fine-tuning
+ */
+
+import fs from 'fs';
+import OpenAI from 'openai';
+
+// Gets the API Key from the environment variable `OPENAI_API_KEY`
+const client = new OpenAI();
+
+async function main() {
+  console.log(`Uploading file`);
+
+  let file = await client.files.create({
+    file: fs.createReadStream('./examples/fine-tune-data.jsonl'),
+    purpose: 'fine-tune',
+  });
+  console.log(`Uploaded file with ID: ${file.id}`);
+  console.log('-----');
+
+  // Wait for the file to be processed
+  console.log(`Waiting for file to be processed`);
+  while (true) {
+    file = await client.files.retrieve(file.id);
+    console.log(`File status: ${file.status}`);
+
+    if (file.status === 'processed') {
+      break;
+    } else {
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+  }
+
+  console.log('-----');
+
+  console.log(`Starting fine-tuning`);
+  let fineTune = await client.fineTuning.jobs.create({ model: 'gpt-3.5-turbo', training_file: file.id });
+  console.log(`Fine-tuning ID: ${fineTune.id}`);
+  console.log('-----');
+
+  console.log(`Track fine-tuning progress:`);
+  let after: string | undefined;
+  while (fineTune.status !== 'succeeded') {
+    fineTune = await client.fineTuning.jobs.retrieve(fineTune.id);
+    console.log(`${fineTune.status}`);
+
+    const options = after ? { limit: 50, after } : { limit: 50 };
+    const events = await client.fineTuning.jobs.listEvents(fineTune.id, options);
+    for (const event of events.data.reverse()) {
+      console.log(`- ${event.created_at}: ${event.message}`);
+    }
+
+    if (events.data.length > 0) {
+      after = events.data[events.data.length - 1]?.id;
+      console.log(after);
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, 5000));
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

src/resources/fine-tuning/jobs.ts

@@ -194,6 +194,8 @@ export interface FineTuningJobEvent {
   message: string;
 
   object: string;
+
+  id: string;
 }
 
 export interface JobCreateParams {