Skip to content

Commit b2c168a

Browse files
style(api): Change fine tuning method retrieve_checkpoints to list_checkpoints
BREAKING CHANGE: Access to the api for listing checkpoints has changed its name to `list_checkpoints`
1 parent 77b1211 commit b2c168a

File tree

6 files changed

+28
-30
lines changed

6 files changed

+28
-30
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 44
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-b267075162e1d64b6091299aad2fa4b4aaf2061839893e87e2c193e29e306eb8.yml
33
openapi_spec_hash: d4b5dc6b33c4898cc49c67a62776d543
4-
config_hash: c503c6b713253e69b5db74d1764d9cc1
4+
config_hash: acbe45d94a426c68447621ec5213405e

api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ Types:
9595
- <code><a href="./src/resources/fine-tuning.ts">FineTuningDeleteResponse</a></code>
9696
- <code><a href="./src/resources/fine-tuning.ts">FineTuningCancelResponse</a></code>
9797
- <code><a href="./src/resources/fine-tuning.ts">FineTuningDownloadResponse</a></code>
98+
- <code><a href="./src/resources/fine-tuning.ts">FineTuningListCheckpointsResponse</a></code>
9899
- <code><a href="./src/resources/fine-tuning.ts">FineTuningListEventsResponse</a></code>
99-
- <code><a href="./src/resources/fine-tuning.ts">FineTuningRetrieveCheckpointsResponse</a></code>
100100

101101
Methods:
102102

@@ -106,8 +106,8 @@ Methods:
106106
- <code title="delete /fine-tunes/{id}">client.fineTuning.<a href="./src/resources/fine-tuning.ts">delete</a>(id, { ...params }) -> FineTuningDeleteResponse</code>
107107
- <code title="post /fine-tunes/{id}/cancel">client.fineTuning.<a href="./src/resources/fine-tuning.ts">cancel</a>(id) -> FineTuningCancelResponse</code>
108108
- <code title="get /finetune/download">client.fineTuning.<a href="./src/resources/fine-tuning.ts">download</a>({ ...params }) -> FineTuningDownloadResponse</code>
109+
- <code title="get /fine-tunes/{id}/checkpoints">client.fineTuning.<a href="./src/resources/fine-tuning.ts">listCheckpoints</a>(id) -> FineTuningListCheckpointsResponse</code>
109110
- <code title="get /fine-tunes/{id}/events">client.fineTuning.<a href="./src/resources/fine-tuning.ts">listEvents</a>(id) -> FineTuningListEventsResponse</code>
110-
- <code title="get /fine-tunes/{id}/checkpoints">client.fineTuning.<a href="./src/resources/fine-tuning.ts">retrieveCheckpoints</a>(id) -> FineTuningRetrieveCheckpointsResponse</code>
111111

112112
# CodeInterpreter
113113

src/client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ import {
8181
FineTuningDeleteResponse,
8282
FineTuningDownloadParams,
8383
FineTuningDownloadResponse,
84+
FineTuningListCheckpointsResponse,
8485
FineTuningListEventsResponse,
8586
FineTuningListResponse,
86-
FineTuningRetrieveCheckpointsResponse,
8787
FullTrainingType,
8888
LinearLrSchedulerArgs,
8989
LoRaTrainingType,
@@ -915,8 +915,8 @@ export declare namespace Together {
915915
type FineTuningDeleteResponse as FineTuningDeleteResponse,
916916
type FineTuningCancelResponse as FineTuningCancelResponse,
917917
type FineTuningDownloadResponse as FineTuningDownloadResponse,
918+
type FineTuningListCheckpointsResponse as FineTuningListCheckpointsResponse,
918919
type FineTuningListEventsResponse as FineTuningListEventsResponse,
919-
type FineTuningRetrieveCheckpointsResponse as FineTuningRetrieveCheckpointsResponse,
920920
type FineTuningCreateParams as FineTuningCreateParams,
921921
type FineTuningDeleteParams as FineTuningDeleteParams,
922922
type FineTuningDownloadParams as FineTuningDownloadParams,

src/resources/fine-tuning.ts

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -97,31 +97,29 @@ export class FineTuning extends APIResource {
9797
}
9898

9999
/**
100-
* List the events for a single fine-tuning job.
100+
* List the checkpoints for a single fine-tuning job.
101101
*
102102
* @example
103103
* ```ts
104-
* const response = await client.fineTuning.listEvents('id');
104+
* const response = await client.fineTuning.listCheckpoints(
105+
* 'id',
106+
* );
105107
* ```
106108
*/
107-
listEvents(id: string, options?: RequestOptions): APIPromise<FineTuningListEventsResponse> {
108-
return this._client.get(path`/fine-tunes/${id}/events`, options);
109+
listCheckpoints(id: string, options?: RequestOptions): APIPromise<FineTuningListCheckpointsResponse> {
110+
return this._client.get(path`/fine-tunes/${id}/checkpoints`, options);
109111
}
110112

111113
/**
112-
* List the checkpoints for a single fine-tuning job.
114+
* List the events for a single fine-tuning job.
113115
*
114116
* @example
115117
* ```ts
116-
* const response =
117-
* await client.fineTuning.retrieveCheckpoints('id');
118+
* const response = await client.fineTuning.listEvents('id');
118119
* ```
119120
*/
120-
retrieveCheckpoints(
121-
id: string,
122-
options?: RequestOptions,
123-
): APIPromise<FineTuningRetrieveCheckpointsResponse> {
124-
return this._client.get(path`/fine-tunes/${id}/checkpoints`, options);
121+
listEvents(id: string, options?: RequestOptions): APIPromise<FineTuningListEventsResponse> {
122+
return this._client.get(path`/fine-tunes/${id}/events`, options);
125123
}
126124
}
127125

@@ -830,15 +828,11 @@ export interface FineTuningDownloadResponse {
830828
size?: number;
831829
}
832830

833-
export interface FineTuningListEventsResponse {
834-
data: Array<FineTuneEvent>;
831+
export interface FineTuningListCheckpointsResponse {
832+
data: Array<FineTuningListCheckpointsResponse.Data>;
835833
}
836834

837-
export interface FineTuningRetrieveCheckpointsResponse {
838-
data: Array<FineTuningRetrieveCheckpointsResponse.Data>;
839-
}
840-
841-
export namespace FineTuningRetrieveCheckpointsResponse {
835+
export namespace FineTuningListCheckpointsResponse {
842836
export interface Data {
843837
checkpoint_type: string;
844838

@@ -850,6 +844,10 @@ export namespace FineTuningRetrieveCheckpointsResponse {
850844
}
851845
}
852846

847+
export interface FineTuningListEventsResponse {
848+
data: Array<FineTuneEvent>;
849+
}
850+
853851
export interface FineTuningCreateParams {
854852
/**
855853
* Name of the base model to run fine-tune job on
@@ -1035,8 +1033,8 @@ export declare namespace FineTuning {
10351033
type FineTuningDeleteResponse as FineTuningDeleteResponse,
10361034
type FineTuningCancelResponse as FineTuningCancelResponse,
10371035
type FineTuningDownloadResponse as FineTuningDownloadResponse,
1036+
type FineTuningListCheckpointsResponse as FineTuningListCheckpointsResponse,
10381037
type FineTuningListEventsResponse as FineTuningListEventsResponse,
1039-
type FineTuningRetrieveCheckpointsResponse as FineTuningRetrieveCheckpointsResponse,
10401038
type FineTuningCreateParams as FineTuningCreateParams,
10411039
type FineTuningDeleteParams as FineTuningDeleteParams,
10421040
type FineTuningDownloadParams as FineTuningDownloadParams,

src/resources/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ export {
8181
type FineTuningDeleteResponse,
8282
type FineTuningCancelResponse,
8383
type FineTuningDownloadResponse,
84+
type FineTuningListCheckpointsResponse,
8485
type FineTuningListEventsResponse,
85-
type FineTuningRetrieveCheckpointsResponse,
8686
type FineTuningCreateParams,
8787
type FineTuningDeleteParams,
8888
type FineTuningDownloadParams,

tests/api-resources/fine-tuning.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ describe('resource fineTuning', () => {
117117
});
118118
});
119119

120-
test('listEvents', async () => {
121-
const responsePromise = client.fineTuning.listEvents('id');
120+
test('listCheckpoints', async () => {
121+
const responsePromise = client.fineTuning.listCheckpoints('id');
122122
const rawResponse = await responsePromise.asResponse();
123123
expect(rawResponse).toBeInstanceOf(Response);
124124
const response = await responsePromise;
@@ -128,8 +128,8 @@ describe('resource fineTuning', () => {
128128
expect(dataAndResponse.response).toBe(rawResponse);
129129
});
130130

131-
test('retrieveCheckpoints', async () => {
132-
const responsePromise = client.fineTuning.retrieveCheckpoints('id');
131+
test('listEvents', async () => {
132+
const responsePromise = client.fineTuning.listEvents('id');
133133
const rawResponse = await responsePromise.asResponse();
134134
expect(rawResponse).toBeInstanceOf(Response);
135135
const response = await responsePromise;

0 commit comments

Comments
 (0)