llama-stack-client 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/.github/workflows/ci.yml +16 -10
  2. package/.gitignore +1 -0
  3. package/.release-please-manifest.json +1 -1
  4. package/.stats.yml +4 -4
  5. package/CHANGELOG.md +80 -0
  6. package/CONTRIBUTING.md +2 -2
  7. package/README.md +22 -0
  8. package/api.md +1 -71
  9. package/dist/CHANGELOG.md +80 -0
  10. package/dist/README.md +22 -0
  11. package/dist/core.d.ts +1 -1
  12. package/dist/core.d.ts.map +1 -1
  13. package/dist/core.js +8 -17
  14. package/dist/core.js.map +1 -1
  15. package/dist/core.mjs +8 -17
  16. package/dist/core.mjs.map +1 -1
  17. package/dist/index.d.mts +51 -12
  18. package/dist/index.d.ts +51 -12
  19. package/dist/index.d.ts.map +1 -1
  20. package/dist/index.js +50 -11
  21. package/dist/index.js.map +1 -1
  22. package/dist/index.mjs +50 -11
  23. package/dist/index.mjs.map +1 -1
  24. package/dist/internal/utils/query.d.ts +2 -0
  25. package/dist/internal/utils/query.d.ts.map +1 -0
  26. package/dist/{resources/alpha/post-training/post-training.js → internal/utils/query.js} +6 -24
  27. package/dist/internal/utils/query.js.map +1 -0
  28. package/dist/{resources/alpha/post-training.mjs → internal/utils/query.mjs} +5 -2
  29. package/dist/internal/utils/query.mjs.map +1 -0
  30. package/dist/package.json +1 -1
  31. package/dist/resources/alpha/alpha.d.ts +0 -4
  32. package/dist/resources/alpha/alpha.d.ts.map +1 -1
  33. package/dist/resources/alpha/alpha.js +0 -4
  34. package/dist/resources/alpha/alpha.js.map +1 -1
  35. package/dist/resources/alpha/alpha.mjs +0 -4
  36. package/dist/resources/alpha/alpha.mjs.map +1 -1
  37. package/dist/resources/alpha/eval/eval.d.ts +3 -0
  38. package/dist/resources/alpha/eval/eval.d.ts.map +1 -1
  39. package/dist/resources/alpha/eval/eval.js +3 -0
  40. package/dist/resources/alpha/eval/eval.js.map +1 -1
  41. package/dist/resources/alpha/eval/eval.mjs +3 -0
  42. package/dist/resources/alpha/eval/eval.mjs.map +1 -1
  43. package/dist/resources/alpha/eval/jobs.d.ts +3 -0
  44. package/dist/resources/alpha/eval/jobs.d.ts.map +1 -1
  45. package/dist/resources/alpha/eval/jobs.js +3 -0
  46. package/dist/resources/alpha/eval/jobs.js.map +1 -1
  47. package/dist/resources/alpha/eval/jobs.mjs +3 -0
  48. package/dist/resources/alpha/eval/jobs.mjs.map +1 -1
  49. package/dist/resources/alpha/index.d.ts +0 -1
  50. package/dist/resources/alpha/index.d.ts.map +1 -1
  51. package/dist/resources/alpha/index.js +1 -3
  52. package/dist/resources/alpha/index.js.map +1 -1
  53. package/dist/resources/alpha/index.mjs +0 -1
  54. package/dist/resources/alpha/index.mjs.map +1 -1
  55. package/dist/resources/alpha/inference.d.ts +8 -0
  56. package/dist/resources/alpha/inference.d.ts.map +1 -1
  57. package/dist/resources/alpha/inference.js +8 -0
  58. package/dist/resources/alpha/inference.js.map +1 -1
  59. package/dist/resources/alpha/inference.mjs +8 -0
  60. package/dist/resources/alpha/inference.mjs.map +1 -1
  61. package/dist/resources/batches.d.ts +8 -0
  62. package/dist/resources/batches.d.ts.map +1 -1
  63. package/dist/resources/batches.js +8 -0
  64. package/dist/resources/batches.js.map +1 -1
  65. package/dist/resources/batches.mjs +8 -0
  66. package/dist/resources/batches.mjs.map +1 -1
  67. package/dist/resources/beta/datasets.d.ts +4 -8
  68. package/dist/resources/beta/datasets.d.ts.map +1 -1
  69. package/dist/resources/chat/chat.d.ts +34 -32
  70. package/dist/resources/chat/chat.d.ts.map +1 -1
  71. package/dist/resources/chat/chat.js.map +1 -1
  72. package/dist/resources/chat/chat.mjs.map +1 -1
  73. package/dist/resources/chat/completions.d.ts +321 -713
  74. package/dist/resources/chat/completions.d.ts.map +1 -1
  75. package/dist/resources/chat/completions.js +8 -0
  76. package/dist/resources/chat/completions.js.map +1 -1
  77. package/dist/resources/chat/completions.mjs +8 -0
  78. package/dist/resources/chat/completions.mjs.map +1 -1
  79. package/dist/resources/completions.d.ts +10 -4
  80. package/dist/resources/completions.d.ts.map +1 -1
  81. package/dist/resources/completions.js +8 -0
  82. package/dist/resources/completions.js.map +1 -1
  83. package/dist/resources/completions.mjs +8 -0
  84. package/dist/resources/completions.mjs.map +1 -1
  85. package/dist/resources/conversations/conversations.d.ts +95 -2
  86. package/dist/resources/conversations/conversations.d.ts.map +1 -1
  87. package/dist/resources/conversations/conversations.js +3 -0
  88. package/dist/resources/conversations/conversations.js.map +1 -1
  89. package/dist/resources/conversations/conversations.mjs +3 -0
  90. package/dist/resources/conversations/conversations.mjs.map +1 -1
  91. package/dist/resources/conversations/items.d.ts +371 -8
  92. package/dist/resources/conversations/items.d.ts.map +1 -1
  93. package/dist/resources/conversations/items.js +3 -0
  94. package/dist/resources/conversations/items.js.map +1 -1
  95. package/dist/resources/conversations/items.mjs +3 -0
  96. package/dist/resources/conversations/items.mjs.map +1 -1
  97. package/dist/resources/embeddings.d.ts +8 -0
  98. package/dist/resources/embeddings.d.ts.map +1 -1
  99. package/dist/resources/embeddings.js +8 -0
  100. package/dist/resources/embeddings.js.map +1 -1
  101. package/dist/resources/embeddings.mjs +8 -0
  102. package/dist/resources/embeddings.mjs.map +1 -1
  103. package/dist/resources/files.d.ts +11 -8
  104. package/dist/resources/files.d.ts.map +1 -1
  105. package/dist/resources/files.js +3 -0
  106. package/dist/resources/files.js.map +1 -1
  107. package/dist/resources/files.mjs +3 -0
  108. package/dist/resources/files.mjs.map +1 -1
  109. package/dist/resources/index.d.ts +1 -4
  110. package/dist/resources/index.d.ts.map +1 -1
  111. package/dist/resources/index.js +1 -7
  112. package/dist/resources/index.js.map +1 -1
  113. package/dist/resources/index.mjs +0 -3
  114. package/dist/resources/index.mjs.map +1 -1
  115. package/dist/resources/inspect.d.ts +3 -0
  116. package/dist/resources/inspect.d.ts.map +1 -1
  117. package/dist/resources/inspect.js +3 -0
  118. package/dist/resources/inspect.js.map +1 -1
  119. package/dist/resources/inspect.mjs +3 -0
  120. package/dist/resources/inspect.mjs.map +1 -1
  121. package/dist/resources/models/index.d.ts +1 -1
  122. package/dist/resources/models/index.d.ts.map +1 -1
  123. package/dist/resources/models/index.js.map +1 -1
  124. package/dist/resources/models/index.mjs.map +1 -1
  125. package/dist/resources/models/models.d.ts +7 -65
  126. package/dist/resources/models/models.d.ts.map +1 -1
  127. package/dist/resources/models/models.js +0 -19
  128. package/dist/resources/models/models.js.map +1 -1
  129. package/dist/resources/models/models.mjs +0 -19
  130. package/dist/resources/models/models.mjs.map +1 -1
  131. package/dist/resources/moderations.d.ts +3 -0
  132. package/dist/resources/moderations.d.ts.map +1 -1
  133. package/dist/resources/moderations.js +3 -0
  134. package/dist/resources/moderations.js.map +1 -1
  135. package/dist/resources/moderations.mjs +3 -0
  136. package/dist/resources/moderations.mjs.map +1 -1
  137. package/dist/resources/prompts/prompts.d.ts +3 -0
  138. package/dist/resources/prompts/prompts.d.ts.map +1 -1
  139. package/dist/resources/prompts/prompts.js +3 -0
  140. package/dist/resources/prompts/prompts.js.map +1 -1
  141. package/dist/resources/prompts/prompts.mjs +3 -0
  142. package/dist/resources/prompts/prompts.mjs.map +1 -1
  143. package/dist/resources/prompts/versions.d.ts +3 -0
  144. package/dist/resources/prompts/versions.d.ts.map +1 -1
  145. package/dist/resources/prompts/versions.js +3 -0
  146. package/dist/resources/prompts/versions.js.map +1 -1
  147. package/dist/resources/prompts/versions.mjs +3 -0
  148. package/dist/resources/prompts/versions.mjs.map +1 -1
  149. package/dist/resources/providers.d.ts +3 -0
  150. package/dist/resources/providers.d.ts.map +1 -1
  151. package/dist/resources/providers.js +3 -0
  152. package/dist/resources/providers.js.map +1 -1
  153. package/dist/resources/providers.mjs +3 -0
  154. package/dist/resources/providers.mjs.map +1 -1
  155. package/dist/resources/responses/input-items.d.ts +102 -3
  156. package/dist/resources/responses/input-items.d.ts.map +1 -1
  157. package/dist/resources/responses/responses.d.ts +582 -11
  158. package/dist/resources/responses/responses.d.ts.map +1 -1
  159. package/dist/resources/responses/responses.js.map +1 -1
  160. package/dist/resources/responses/responses.mjs.map +1 -1
  161. package/dist/resources/routes.d.ts +3 -0
  162. package/dist/resources/routes.d.ts.map +1 -1
  163. package/dist/resources/routes.js +3 -0
  164. package/dist/resources/routes.js.map +1 -1
  165. package/dist/resources/routes.mjs +3 -0
  166. package/dist/resources/routes.mjs.map +1 -1
  167. package/dist/resources/safety.d.ts +14 -11
  168. package/dist/resources/safety.d.ts.map +1 -1
  169. package/dist/resources/safety.js +3 -0
  170. package/dist/resources/safety.js.map +1 -1
  171. package/dist/resources/safety.mjs +3 -0
  172. package/dist/resources/safety.mjs.map +1 -1
  173. package/dist/resources/vector-io.d.ts +4 -4
  174. package/dist/resources/vector-stores/file-batches.d.ts +49 -1
  175. package/dist/resources/vector-stores/file-batches.d.ts.map +1 -1
  176. package/dist/resources/vector-stores/file-batches.js.map +1 -1
  177. package/dist/resources/vector-stores/file-batches.mjs.map +1 -1
  178. package/dist/resources/vector-stores/files.d.ts +100 -4
  179. package/dist/resources/vector-stores/files.d.ts.map +1 -1
  180. package/dist/resources/vector-stores/files.js.map +1 -1
  181. package/dist/resources/vector-stores/files.mjs.map +1 -1
  182. package/dist/resources/vector-stores/vector-stores.d.ts +51 -3
  183. package/dist/resources/vector-stores/vector-stores.d.ts.map +1 -1
  184. package/dist/resources/vector-stores/vector-stores.js.map +1 -1
  185. package/dist/resources/vector-stores/vector-stores.mjs.map +1 -1
  186. package/dist/src/core.ts +10 -21
  187. package/dist/src/index.ts +51 -48
  188. package/{src/resources/alpha/post-training.ts → dist/src/internal/utils/query.ts} +5 -1
  189. package/dist/src/resources/alpha/alpha.ts +0 -20
  190. package/dist/src/resources/alpha/eval/eval.ts +3 -0
  191. package/dist/src/resources/alpha/eval/jobs.ts +3 -0
  192. package/dist/src/resources/alpha/index.ts +0 -8
  193. package/dist/src/resources/alpha/inference.ts +8 -0
  194. package/dist/src/resources/batches.ts +8 -0
  195. package/dist/src/resources/beta/datasets.ts +4 -9
  196. package/dist/src/resources/chat/chat.ts +36 -33
  197. package/dist/src/resources/chat/completions.ts +307 -811
  198. package/dist/src/resources/completions.ts +10 -4
  199. package/dist/src/resources/conversations/conversations.ts +121 -1
  200. package/dist/src/resources/conversations/items.ts +477 -6
  201. package/dist/src/resources/embeddings.ts +8 -0
  202. package/dist/src/resources/files.ts +12 -9
  203. package/dist/src/resources/index.ts +0 -18
  204. package/dist/src/resources/inspect.ts +3 -0
  205. package/dist/src/resources/models/index.ts +0 -2
  206. package/dist/src/resources/models/models.ts +7 -82
  207. package/dist/src/resources/moderations.ts +3 -0
  208. package/dist/src/resources/prompts/prompts.ts +3 -0
  209. package/dist/src/resources/prompts/versions.ts +3 -0
  210. package/dist/src/resources/providers.ts +3 -0
  211. package/dist/src/resources/responses/input-items.ts +128 -2
  212. package/dist/src/resources/responses/responses.ts +706 -7
  213. package/dist/src/resources/routes.ts +3 -0
  214. package/dist/src/resources/safety.ts +15 -12
  215. package/dist/src/resources/vector-io.ts +4 -4
  216. package/dist/src/resources/vector-stores/file-batches.ts +57 -0
  217. package/dist/src/resources/vector-stores/files.ts +117 -3
  218. package/dist/src/resources/vector-stores/vector-stores.ts +59 -2
  219. package/dist/src/streaming.ts +24 -6
  220. package/dist/src/version.ts +1 -1
  221. package/dist/streaming.d.ts.map +1 -1
  222. package/dist/streaming.js +21 -6
  223. package/dist/streaming.js.map +1 -1
  224. package/dist/streaming.mjs +21 -6
  225. package/dist/streaming.mjs.map +1 -1
  226. package/dist/version.d.ts +1 -1
  227. package/dist/version.js +1 -1
  228. package/dist/version.mjs +1 -1
  229. package/package.json +1 -1
  230. package/scripts/mock +21 -10
  231. package/scripts/test +8 -8
  232. package/src/core.ts +10 -21
  233. package/src/index.ts +51 -48
  234. package/{dist/src/resources/alpha/post-training.ts → src/internal/utils/query.ts} +5 -1
  235. package/src/resources/alpha/alpha.ts +0 -20
  236. package/src/resources/alpha/eval/eval.ts +3 -0
  237. package/src/resources/alpha/eval/jobs.ts +3 -0
  238. package/src/resources/alpha/index.ts +0 -8
  239. package/src/resources/alpha/inference.ts +8 -0
  240. package/src/resources/batches.ts +8 -0
  241. package/src/resources/beta/datasets.ts +4 -9
  242. package/src/resources/chat/chat.ts +36 -33
  243. package/src/resources/chat/completions.ts +307 -811
  244. package/src/resources/completions.ts +10 -4
  245. package/src/resources/conversations/conversations.ts +121 -1
  246. package/src/resources/conversations/items.ts +477 -6
  247. package/src/resources/embeddings.ts +8 -0
  248. package/src/resources/files.ts +12 -9
  249. package/src/resources/index.ts +0 -18
  250. package/src/resources/inspect.ts +3 -0
  251. package/src/resources/models/index.ts +0 -2
  252. package/src/resources/models/models.ts +7 -82
  253. package/src/resources/moderations.ts +3 -0
  254. package/src/resources/prompts/prompts.ts +3 -0
  255. package/src/resources/prompts/versions.ts +3 -0
  256. package/src/resources/providers.ts +3 -0
  257. package/src/resources/responses/input-items.ts +128 -2
  258. package/src/resources/responses/responses.ts +706 -7
  259. package/src/resources/routes.ts +3 -0
  260. package/src/resources/safety.ts +15 -12
  261. package/src/resources/vector-io.ts +4 -4
  262. package/src/resources/vector-stores/file-batches.ts +57 -0
  263. package/src/resources/vector-stores/files.ts +117 -3
  264. package/src/resources/vector-stores/vector-stores.ts +59 -2
  265. package/src/streaming.ts +24 -6
  266. package/src/version.ts +1 -1
  267. package/tests/api-resources/beta/datasets.test.ts +4 -10
  268. package/tests/api-resources/chat/completions.test.ts +2 -0
  269. package/tests/api-resources/files.test.ts +2 -2
  270. package/tests/api-resources/models/models.test.ts +0 -39
  271. package/tests/api-resources/responses/responses.test.ts +10 -1
  272. package/tests/api-resources/vector-stores/file-batches.test.ts +1 -1
  273. package/tests/api-resources/vector-stores/files.test.ts +1 -1
  274. package/tests/api-resources/vector-stores/vector-stores.test.ts +1 -1
  275. package/tests/stringifyQuery.test.ts +2 -4
  276. package/dist/resources/alpha/post-training/index.d.ts +0 -3
  277. package/dist/resources/alpha/post-training/index.d.ts.map +0 -1
  278. package/dist/resources/alpha/post-training/index.js +0 -15
  279. package/dist/resources/alpha/post-training/index.js.map +0 -1
  280. package/dist/resources/alpha/post-training/index.mjs +0 -10
  281. package/dist/resources/alpha/post-training/index.mjs.map +0 -1
  282. package/dist/resources/alpha/post-training/job.d.ts +0 -104
  283. package/dist/resources/alpha/post-training/job.d.ts.map +0 -1
  284. package/dist/resources/alpha/post-training/job.js +0 -42
  285. package/dist/resources/alpha/post-training/job.js.map +0 -1
  286. package/dist/resources/alpha/post-training/job.mjs +0 -38
  287. package/dist/resources/alpha/post-training/job.mjs.map +0 -1
  288. package/dist/resources/alpha/post-training/post-training.d.ts +0 -269
  289. package/dist/resources/alpha/post-training/post-training.d.ts.map +0 -1
  290. package/dist/resources/alpha/post-training/post-training.js.map +0 -1
  291. package/dist/resources/alpha/post-training/post-training.mjs +0 -30
  292. package/dist/resources/alpha/post-training/post-training.mjs.map +0 -1
  293. package/dist/resources/alpha/post-training.d.ts +0 -2
  294. package/dist/resources/alpha/post-training.d.ts.map +0 -1
  295. package/dist/resources/alpha/post-training.js +0 -25
  296. package/dist/resources/alpha/post-training.js.map +0 -1
  297. package/dist/resources/alpha/post-training.mjs.map +0 -1
  298. package/dist/resources/tool-runtime.d.ts +0 -152
  299. package/dist/resources/tool-runtime.d.ts.map +0 -1
  300. package/dist/resources/tool-runtime.js +0 -30
  301. package/dist/resources/tool-runtime.js.map +0 -1
  302. package/dist/resources/tool-runtime.mjs +0 -26
  303. package/dist/resources/tool-runtime.mjs.map +0 -1
  304. package/dist/resources/toolgroups.d.ts +0 -91
  305. package/dist/resources/toolgroups.d.ts.map +0 -1
  306. package/dist/resources/toolgroups.js +0 -54
  307. package/dist/resources/toolgroups.js.map +0 -1
  308. package/dist/resources/toolgroups.mjs +0 -50
  309. package/dist/resources/toolgroups.mjs.map +0 -1
  310. package/dist/resources/tools.d.ts +0 -26
  311. package/dist/resources/tools.d.ts.map +0 -1
  312. package/dist/resources/tools.js +0 -30
  313. package/dist/resources/tools.js.map +0 -1
  314. package/dist/resources/tools.mjs +0 -26
  315. package/dist/resources/tools.mjs.map +0 -1
  316. package/dist/src/resources/alpha/post-training/index.ts +0 -17
  317. package/dist/src/resources/alpha/post-training/job.ts +0 -161
  318. package/dist/src/resources/alpha/post-training/post-training.ts +0 -385
  319. package/dist/src/resources/tool-runtime.ts +0 -217
  320. package/dist/src/resources/toolgroups.ts +0 -135
  321. package/dist/src/resources/tools.ts +0 -52
  322. package/src/resources/alpha/post-training/index.ts +0 -17
  323. package/src/resources/alpha/post-training/job.ts +0 -161
  324. package/src/resources/alpha/post-training/post-training.ts +0 -385
  325. package/src/resources/tool-runtime.ts +0 -217
  326. package/src/resources/toolgroups.ts +0 -135
  327. package/src/resources/tools.ts +0 -52
  328. package/tests/api-resources/alpha/post-training/job.test.ts +0 -86
  329. package/tests/api-resources/alpha/post-training/post-training.test.ts +0 -134
  330. package/tests/api-resources/tool-runtime.test.ts +0 -68
  331. package/tests/api-resources/toolgroups.test.ts +0 -91
  332. package/tests/api-resources/tools.test.ts +0 -57
@@ -1,161 +0,0 @@
1
- // Copyright (c) Meta Platforms, Inc. and affiliates.
2
- // All rights reserved.
3
- //
4
- // This source code is licensed under the terms described in the LICENSE file in
5
- // the root directory of this source tree.
6
- //
7
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
8
-
9
- import { APIResource } from '../../../resource';
10
- import * as Core from '../../../core';
11
- import * as PostTrainingAPI from './post-training';
12
-
13
- export class Job extends APIResource {
14
- /**
15
- * Get all training jobs.
16
- */
17
- list(options?: Core.RequestOptions): Core.APIPromise<JobListResponse> {
18
- return (
19
- this._client.get('/v1alpha/post-training/jobs', options) as Core.APIPromise<{ data: JobListResponse }>
20
- )._thenUnwrap((obj) => obj.data);
21
- }
22
-
23
- /**
24
- * Get the artifacts of a training job.
25
- */
26
- artifacts(options?: Core.RequestOptions): Core.APIPromise<JobArtifactsResponse> {
27
- return this._client.get('/v1alpha/post-training/job/artifacts', options);
28
- }
29
-
30
- /**
31
- * Cancel a training job.
32
- */
33
- cancel(options?: Core.RequestOptions): Core.APIPromise<void> {
34
- return this._client.post('/v1alpha/post-training/job/cancel', {
35
- ...options,
36
- headers: { Accept: '*/*', ...options?.headers },
37
- });
38
- }
39
-
40
- /**
41
- * Get the status of a training job.
42
- */
43
- status(options?: Core.RequestOptions): Core.APIPromise<JobStatusResponse> {
44
- return this._client.get('/v1alpha/post-training/job/status', options);
45
- }
46
- }
47
-
48
- export type JobListResponse = Array<PostTrainingAPI.PostTrainingJob>;
49
-
50
- /**
51
- * Artifacts of a finetuning job.
52
- */
53
- export interface JobArtifactsResponse {
54
- job_uuid: string;
55
-
56
- checkpoints?: Array<JobArtifactsResponse.Checkpoint>;
57
- }
58
-
59
- export namespace JobArtifactsResponse {
60
- /**
61
- * Checkpoint created during training runs.
62
- */
63
- export interface Checkpoint {
64
- created_at: string;
65
-
66
- epoch: number;
67
-
68
- identifier: string;
69
-
70
- path: string;
71
-
72
- post_training_job_id: string;
73
-
74
- /**
75
- * Training metrics captured during post-training jobs.
76
- */
77
- training_metrics?: Checkpoint.TrainingMetrics | null;
78
- }
79
-
80
- export namespace Checkpoint {
81
- /**
82
- * Training metrics captured during post-training jobs.
83
- */
84
- export interface TrainingMetrics {
85
- epoch: number;
86
-
87
- perplexity: number;
88
-
89
- train_loss: number;
90
-
91
- validation_loss: number;
92
- }
93
- }
94
- }
95
-
96
- /**
97
- * Status of a finetuning job.
98
- */
99
- export interface JobStatusResponse {
100
- job_uuid: string;
101
-
102
- /**
103
- * Status of a job execution.
104
- */
105
- status: 'completed' | 'in_progress' | 'failed' | 'scheduled' | 'cancelled';
106
-
107
- checkpoints?: Array<JobStatusResponse.Checkpoint>;
108
-
109
- completed_at?: string | null;
110
-
111
- resources_allocated?: { [key: string]: unknown } | null;
112
-
113
- scheduled_at?: string | null;
114
-
115
- started_at?: string | null;
116
- }
117
-
118
- export namespace JobStatusResponse {
119
- /**
120
- * Checkpoint created during training runs.
121
- */
122
- export interface Checkpoint {
123
- created_at: string;
124
-
125
- epoch: number;
126
-
127
- identifier: string;
128
-
129
- path: string;
130
-
131
- post_training_job_id: string;
132
-
133
- /**
134
- * Training metrics captured during post-training jobs.
135
- */
136
- training_metrics?: Checkpoint.TrainingMetrics | null;
137
- }
138
-
139
- export namespace Checkpoint {
140
- /**
141
- * Training metrics captured during post-training jobs.
142
- */
143
- export interface TrainingMetrics {
144
- epoch: number;
145
-
146
- perplexity: number;
147
-
148
- train_loss: number;
149
-
150
- validation_loss: number;
151
- }
152
- }
153
- }
154
-
155
- export declare namespace Job {
156
- export {
157
- type JobListResponse as JobListResponse,
158
- type JobArtifactsResponse as JobArtifactsResponse,
159
- type JobStatusResponse as JobStatusResponse,
160
- };
161
- }
@@ -1,385 +0,0 @@
1
- // Copyright (c) Meta Platforms, Inc. and affiliates.
2
- // All rights reserved.
3
- //
4
- // This source code is licensed under the terms described in the LICENSE file in
5
- // the root directory of this source tree.
6
- //
7
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
8
-
9
- import { APIResource } from '../../../resource';
10
- import * as Core from '../../../core';
11
- import * as JobAPI from './job';
12
- import { Job, JobArtifactsResponse, JobListResponse, JobStatusResponse } from './job';
13
-
14
- export class PostTraining extends APIResource {
15
- job: JobAPI.Job = new JobAPI.Job(this._client);
16
-
17
- /**
18
- * Run preference optimization of a model.
19
- */
20
- preferenceOptimize(
21
- body: PostTrainingPreferenceOptimizeParams,
22
- options?: Core.RequestOptions,
23
- ): Core.APIPromise<PostTrainingJob> {
24
- return this._client.post('/v1alpha/post-training/preference-optimize', { body, ...options });
25
- }
26
-
27
- /**
28
- * Run supervised fine-tuning of a model.
29
- */
30
- supervisedFineTune(
31
- body: PostTrainingSupervisedFineTuneParams,
32
- options?: Core.RequestOptions,
33
- ): Core.APIPromise<PostTrainingJob> {
34
- return this._client.post('/v1alpha/post-training/supervised-fine-tune', { body, ...options });
35
- }
36
- }
37
-
38
- /**
39
- * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
40
- */
41
- export type AlgorithmConfig = AlgorithmConfig.LoraFinetuningConfig | AlgorithmConfig.QatFinetuningConfig;
42
-
43
- export namespace AlgorithmConfig {
44
- /**
45
- * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
46
- */
47
- export interface LoraFinetuningConfig {
48
- alpha: number;
49
-
50
- apply_lora_to_mlp: boolean;
51
-
52
- apply_lora_to_output: boolean;
53
-
54
- lora_attn_modules: Array<string>;
55
-
56
- rank: number;
57
-
58
- quantize_base?: boolean | null;
59
-
60
- type?: 'LoRA';
61
-
62
- use_dora?: boolean | null;
63
- }
64
-
65
- /**
66
- * Configuration for Quantization-Aware Training (QAT) fine-tuning.
67
- */
68
- export interface QatFinetuningConfig {
69
- group_size: number;
70
-
71
- quantizer_name: string;
72
-
73
- type?: 'QAT';
74
- }
75
- }
76
-
77
- export interface ListPostTrainingJobsResponse {
78
- data: JobAPI.JobListResponse;
79
- }
80
-
81
- export interface PostTrainingJob {
82
- job_uuid: string;
83
- }
84
-
85
- export interface PostTrainingPreferenceOptimizeParams {
86
- /**
87
- * The algorithm configuration.
88
- */
89
- algorithm_config: PostTrainingPreferenceOptimizeParams.AlgorithmConfig;
90
-
91
- /**
92
- * The model to fine-tune.
93
- */
94
- finetuned_model: string;
95
-
96
- /**
97
- * The hyperparam search configuration.
98
- */
99
- hyperparam_search_config: { [key: string]: unknown };
100
-
101
- /**
102
- * The UUID of the job to create.
103
- */
104
- job_uuid: string;
105
-
106
- /**
107
- * The logger configuration.
108
- */
109
- logger_config: { [key: string]: unknown };
110
-
111
- /**
112
- * The training configuration.
113
- */
114
- training_config: PostTrainingPreferenceOptimizeParams.TrainingConfig;
115
- }
116
-
117
- export namespace PostTrainingPreferenceOptimizeParams {
118
- /**
119
- * The algorithm configuration.
120
- */
121
- export interface AlgorithmConfig {
122
- beta: number;
123
-
124
- loss_type?: 'sigmoid' | 'hinge' | 'ipo' | 'kto_pair';
125
- }
126
-
127
- /**
128
- * The training configuration.
129
- */
130
- export interface TrainingConfig {
131
- n_epochs: number;
132
-
133
- /**
134
- * Configuration for training data and data loading.
135
- */
136
- data_config?: TrainingConfig.DataConfig | null;
137
-
138
- dtype?: string | null;
139
-
140
- /**
141
- * Configuration for memory and compute efficiency optimizations.
142
- */
143
- efficiency_config?: TrainingConfig.EfficiencyConfig | null;
144
-
145
- gradient_accumulation_steps?: number;
146
-
147
- max_steps_per_epoch?: number;
148
-
149
- max_validation_steps?: number | null;
150
-
151
- /**
152
- * Configuration parameters for the optimization algorithm.
153
- */
154
- optimizer_config?: TrainingConfig.OptimizerConfig | null;
155
- }
156
-
157
- export namespace TrainingConfig {
158
- /**
159
- * Configuration for training data and data loading.
160
- */
161
- export interface DataConfig {
162
- batch_size: number;
163
-
164
- /**
165
- * Format of the training dataset.
166
- */
167
- data_format: 'instruct' | 'dialog';
168
-
169
- dataset_id: string;
170
-
171
- shuffle: boolean;
172
-
173
- packed?: boolean | null;
174
-
175
- train_on_input?: boolean | null;
176
-
177
- validation_dataset_id?: string | null;
178
- }
179
-
180
- /**
181
- * Configuration for memory and compute efficiency optimizations.
182
- */
183
- export interface EfficiencyConfig {
184
- enable_activation_checkpointing?: boolean | null;
185
-
186
- enable_activation_offloading?: boolean | null;
187
-
188
- fsdp_cpu_offload?: boolean | null;
189
-
190
- memory_efficient_fsdp_wrap?: boolean | null;
191
- }
192
-
193
- /**
194
- * Configuration parameters for the optimization algorithm.
195
- */
196
- export interface OptimizerConfig {
197
- lr: number;
198
-
199
- num_warmup_steps: number;
200
-
201
- /**
202
- * Available optimizer algorithms for training.
203
- */
204
- optimizer_type: 'adam' | 'adamw' | 'sgd';
205
-
206
- weight_decay: number;
207
- }
208
- }
209
- }
210
-
211
- export interface PostTrainingSupervisedFineTuneParams {
212
- /**
213
- * The hyperparam search configuration.
214
- */
215
- hyperparam_search_config: { [key: string]: unknown };
216
-
217
- /**
218
- * The UUID of the job to create.
219
- */
220
- job_uuid: string;
221
-
222
- /**
223
- * The logger configuration.
224
- */
225
- logger_config: { [key: string]: unknown };
226
-
227
- /**
228
- * The training configuration.
229
- */
230
- training_config: PostTrainingSupervisedFineTuneParams.TrainingConfig;
231
-
232
- /**
233
- * The algorithm configuration.
234
- */
235
- algorithm_config?:
236
- | PostTrainingSupervisedFineTuneParams.LoraFinetuningConfig
237
- | PostTrainingSupervisedFineTuneParams.QatFinetuningConfig
238
- | null;
239
-
240
- /**
241
- * The directory to save checkpoint(s) to.
242
- */
243
- checkpoint_dir?: string | null;
244
-
245
- /**
246
- * Model descriptor for training if not in provider config
247
- */
248
- model?: string | null;
249
- }
250
-
251
- export namespace PostTrainingSupervisedFineTuneParams {
252
- /**
253
- * The training configuration.
254
- */
255
- export interface TrainingConfig {
256
- n_epochs: number;
257
-
258
- /**
259
- * Configuration for training data and data loading.
260
- */
261
- data_config?: TrainingConfig.DataConfig | null;
262
-
263
- dtype?: string | null;
264
-
265
- /**
266
- * Configuration for memory and compute efficiency optimizations.
267
- */
268
- efficiency_config?: TrainingConfig.EfficiencyConfig | null;
269
-
270
- gradient_accumulation_steps?: number;
271
-
272
- max_steps_per_epoch?: number;
273
-
274
- max_validation_steps?: number | null;
275
-
276
- /**
277
- * Configuration parameters for the optimization algorithm.
278
- */
279
- optimizer_config?: TrainingConfig.OptimizerConfig | null;
280
- }
281
-
282
- export namespace TrainingConfig {
283
- /**
284
- * Configuration for training data and data loading.
285
- */
286
- export interface DataConfig {
287
- batch_size: number;
288
-
289
- /**
290
- * Format of the training dataset.
291
- */
292
- data_format: 'instruct' | 'dialog';
293
-
294
- dataset_id: string;
295
-
296
- shuffle: boolean;
297
-
298
- packed?: boolean | null;
299
-
300
- train_on_input?: boolean | null;
301
-
302
- validation_dataset_id?: string | null;
303
- }
304
-
305
- /**
306
- * Configuration for memory and compute efficiency optimizations.
307
- */
308
- export interface EfficiencyConfig {
309
- enable_activation_checkpointing?: boolean | null;
310
-
311
- enable_activation_offloading?: boolean | null;
312
-
313
- fsdp_cpu_offload?: boolean | null;
314
-
315
- memory_efficient_fsdp_wrap?: boolean | null;
316
- }
317
-
318
- /**
319
- * Configuration parameters for the optimization algorithm.
320
- */
321
- export interface OptimizerConfig {
322
- lr: number;
323
-
324
- num_warmup_steps: number;
325
-
326
- /**
327
- * Available optimizer algorithms for training.
328
- */
329
- optimizer_type: 'adam' | 'adamw' | 'sgd';
330
-
331
- weight_decay: number;
332
- }
333
- }
334
-
335
- /**
336
- * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
337
- */
338
- export interface LoraFinetuningConfig {
339
- alpha: number;
340
-
341
- apply_lora_to_mlp: boolean;
342
-
343
- apply_lora_to_output: boolean;
344
-
345
- lora_attn_modules: Array<string>;
346
-
347
- rank: number;
348
-
349
- quantize_base?: boolean | null;
350
-
351
- type?: 'LoRA';
352
-
353
- use_dora?: boolean | null;
354
- }
355
-
356
- /**
357
- * Configuration for Quantization-Aware Training (QAT) fine-tuning.
358
- */
359
- export interface QatFinetuningConfig {
360
- group_size: number;
361
-
362
- quantizer_name: string;
363
-
364
- type?: 'QAT';
365
- }
366
- }
367
-
368
- PostTraining.Job = Job;
369
-
370
- export declare namespace PostTraining {
371
- export {
372
- type AlgorithmConfig as AlgorithmConfig,
373
- type ListPostTrainingJobsResponse as ListPostTrainingJobsResponse,
374
- type PostTrainingJob as PostTrainingJob,
375
- type PostTrainingPreferenceOptimizeParams as PostTrainingPreferenceOptimizeParams,
376
- type PostTrainingSupervisedFineTuneParams as PostTrainingSupervisedFineTuneParams,
377
- };
378
-
379
- export {
380
- Job as Job,
381
- type JobListResponse as JobListResponse,
382
- type JobArtifactsResponse as JobArtifactsResponse,
383
- type JobStatusResponse as JobStatusResponse,
384
- };
385
- }