forked from openai/openai-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Quantstruct: update changelog and fine-tuning guide for OpenAPI spec β¦ #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
quantstruct-bot
wants to merge
3
commits into
master
Choose a base branch
from
quantstruct-202501231406
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Updates to Admin APIs, Real-time Sessions, and Fine-tuning Request Payloads | ||
|
||
1. **New admin API key endpoints**: You can now manage admin-level keys with βGET,β βPOST,β βGET by ID,β and βDELETEβ calls at `/organization/admin_api_keys`. This makes it easier to create, review, and delete high-permission keys without mixing them up with normal API keys. | ||
2. **New realtime sessions endpoint**: There is now a βPOST /realtime/sessionsβ method for ephemeral token creation. This lets you quickly generate short-lived client tokens to power more dynamic, real-time applications. | ||
Example Payload: | ||
```json | ||
{ | ||
"model": "gpt-4o-realtime-preview-2024-12-17", | ||
"modalities": ["audio", "text"], | ||
"instructions": "You are a helpful assistant.", | ||
"voice": "alloy", | ||
"input_audio_format": "pcm16", | ||
"output_audio_format": "pcm16", | ||
"input_audio_transcription": { | ||
"model": "whisper-1" | ||
}, | ||
"turn_detection": null, | ||
"tools": [], | ||
"tool_choice": "auto", | ||
"temperature": 0.8, | ||
"max_response_output_tokens": "inf" | ||
} | ||
``` | ||
|
||
3. **Fine-tuning job creation changed**: the request now requires you to nest fields under βmethodβ with βtypeβ and βhyperparametersβ inside. The [finetuning UI](https://platform.openai.com/finetune) remains unchanged | ||
```json | ||
{ | ||
"training_file": "file-abc123", | ||
"model": "gpt-4o-mini", | ||
"method": { | ||
"type": "supervised", | ||
"supervised": { | ||
"hyperparameters": { | ||
"n_epochs": 2 | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# OpenAI Fine-tuning Guide | ||
|
||
## Overview | ||
Fine-tuning lets you customize OpenAI models by training them on your data to improve style, reliability, and task-specific performance. | ||
|
||
- Setting specific style, tone, or format | ||
- Improving reliability for desired outputs | ||
- Handling complex prompts and edge cases | ||
- Teaching new skills or tasks | ||
|
||
## Currently Available Models | ||
|
||
- `gpt-4o-mini` (recommended for most users) | ||
- `gpt-3.5-turbo` | ||
- `babbage-002` | ||
- `davinci-002` | ||
|
||
Note: GPT-4 fine-tuning is in experimental access. | ||
|
||
## Step-by-Step Guide | ||
|
||
### 1. Prepare Dataset | ||
Create a JSONL file with conversation examples: | ||
|
||
### 2. Create Fine-tuning Job | ||
Use the OpenAI API to create a fine-tuning job: | ||
|
||
### 3. Monitor Job | ||
Use the dashboard to track job status and progress. | ||
|
||
### 4. Evaluate Model | ||
|
||
### 5. Deploy Model |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add screenshot of finetuning dashboard