|
1 | 1 | # Reference |
2 | | -## V1 |
3 | | -<details><summary><code>client.v1.<a href="src/truefoundry_sdk/v1/client.py">apply</a>(...)</code></summary> |
4 | | -<dl> |
5 | | -<dd> |
6 | | - |
7 | | -#### 🔌 Usage |
8 | | - |
9 | | -<dl> |
10 | | -<dd> |
11 | | - |
12 | | -<dl> |
13 | | -<dd> |
14 | | - |
15 | | -```python |
16 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
17 | | - |
18 | | -client = TrueFoundry( |
19 | | - api_key="YOUR_API_KEY", |
20 | | - base_url="https://yourhost.com/path/to/api", |
21 | | -) |
22 | | -client.v1.apply( |
23 | | - manifest=Model( |
24 | | - metadata={"key": "value"}, |
25 | | - source=TrueFoundryManagedSource(), |
26 | | - ), |
27 | | -) |
28 | | - |
29 | | -``` |
30 | | -</dd> |
31 | | -</dl> |
32 | | -</dd> |
33 | | -</dl> |
34 | | - |
35 | | -#### ⚙️ Parameters |
36 | | - |
37 | | -<dl> |
38 | | -<dd> |
39 | | - |
40 | | -<dl> |
41 | | -<dd> |
42 | | - |
43 | | -**manifest:** `Manifest` |
44 | | - |
45 | | -</dd> |
46 | | -</dl> |
47 | | - |
48 | | -<dl> |
49 | | -<dd> |
50 | | - |
51 | | -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
52 | | - |
53 | | -</dd> |
54 | | -</dl> |
55 | | -</dd> |
56 | | -</dl> |
57 | | - |
58 | | - |
59 | | -</dd> |
60 | | -</dl> |
61 | | -</details> |
62 | | - |
63 | | -## Health |
64 | | -<details><summary><code>client.health.<a href="src/truefoundry_sdk/health/client.py">serve_get</a>()</code></summary> |
65 | | -<dl> |
66 | | -<dd> |
67 | | - |
68 | | -#### 🔌 Usage |
69 | | - |
70 | | -<dl> |
71 | | -<dd> |
72 | | - |
73 | | -<dl> |
74 | | -<dd> |
75 | | - |
76 | | -```python |
77 | | -from truefoundry_sdk import TrueFoundry |
78 | | - |
79 | | -client = TrueFoundry( |
80 | | - api_key="YOUR_API_KEY", |
81 | | - base_url="https://yourhost.com/path/to/api", |
82 | | -) |
83 | | -client.health.serve_get() |
84 | | - |
85 | | -``` |
86 | | -</dd> |
87 | | -</dl> |
88 | | -</dd> |
89 | | -</dl> |
90 | | - |
91 | | -#### ⚙️ Parameters |
92 | | - |
93 | | -<dl> |
94 | | -<dd> |
95 | | - |
96 | | -<dl> |
97 | | -<dd> |
98 | | - |
99 | | -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
100 | | - |
101 | | -</dd> |
102 | | -</dl> |
103 | | -</dd> |
104 | | -</dl> |
105 | | - |
106 | | - |
107 | | -</dd> |
108 | | -</dl> |
109 | | -</details> |
110 | | - |
111 | | -<details><summary><code>client.health.<a href="src/truefoundry_sdk/health/client.py">get</a>()</code></summary> |
112 | | -<dl> |
113 | | -<dd> |
114 | | - |
115 | | -#### 🔌 Usage |
116 | | - |
117 | | -<dl> |
118 | | -<dd> |
119 | | - |
120 | | -<dl> |
121 | | -<dd> |
122 | | - |
123 | | -```python |
124 | | -from truefoundry_sdk import TrueFoundry |
125 | | - |
126 | | -client = TrueFoundry( |
127 | | - api_key="YOUR_API_KEY", |
128 | | - base_url="https://yourhost.com/path/to/api", |
129 | | -) |
130 | | -client.health.get() |
131 | | - |
132 | | -``` |
133 | | -</dd> |
134 | | -</dl> |
135 | | -</dd> |
136 | | -</dl> |
137 | | - |
138 | | -#### ⚙️ Parameters |
139 | | - |
140 | | -<dl> |
141 | | -<dd> |
142 | | - |
143 | | -<dl> |
144 | | -<dd> |
145 | | - |
146 | | -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. |
147 | | - |
148 | | -</dd> |
149 | | -</dl> |
150 | | -</dd> |
151 | | -</dl> |
152 | | - |
153 | | - |
154 | | -</dd> |
155 | | -</dl> |
156 | | -</details> |
157 | | - |
158 | 2 | ## V1 Artifacts |
159 | 3 | <details><summary><code>client.v1.artifacts.<a href="src/truefoundry_sdk/v1/artifacts/client.py">get</a>(...)</code></summary> |
160 | 4 | <dl> |
@@ -375,15 +219,17 @@ for page in response.iter_pages(): |
375 | 219 | <dd> |
376 | 220 |
|
377 | 221 | ```python |
378 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 222 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
379 | 223 |
|
380 | 224 | client = TrueFoundry( |
381 | 225 | api_key="YOUR_API_KEY", |
382 | 226 | base_url="https://yourhost.com/path/to/api", |
383 | 227 | ) |
384 | 228 | client.v1.artifacts.create_or_update( |
385 | | - manifest=Model( |
| 229 | + manifest=ModelManifest( |
| 230 | + name="name", |
386 | 231 | metadata={"key": "value"}, |
| 232 | + ml_repo="ml_repo", |
387 | 233 | source=TrueFoundryManagedSource(), |
388 | 234 | ), |
389 | 235 | ) |
@@ -634,15 +480,17 @@ for page in response.iter_pages(): |
634 | 480 | <dd> |
635 | 481 |
|
636 | 482 | ```python |
637 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 483 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
638 | 484 |
|
639 | 485 | client = TrueFoundry( |
640 | 486 | api_key="YOUR_API_KEY", |
641 | 487 | base_url="https://yourhost.com/path/to/api", |
642 | 488 | ) |
643 | 489 | client.v1.agents.create_or_update( |
644 | | - manifest=Model( |
| 490 | + manifest=ModelManifest( |
| 491 | + name="name", |
645 | 492 | metadata={"key": "value"}, |
| 493 | + ml_repo="ml_repo", |
646 | 494 | source=TrueFoundryManagedSource(), |
647 | 495 | ), |
648 | 496 | ) |
@@ -893,15 +741,17 @@ for page in response.iter_pages(): |
893 | 741 | <dd> |
894 | 742 |
|
895 | 743 | ```python |
896 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 744 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
897 | 745 |
|
898 | 746 | client = TrueFoundry( |
899 | 747 | api_key="YOUR_API_KEY", |
900 | 748 | base_url="https://yourhost.com/path/to/api", |
901 | 749 | ) |
902 | 750 | client.v1.prompts.create_or_update( |
903 | | - manifest=Model( |
| 751 | + manifest=ModelManifest( |
| 752 | + name="name", |
904 | 753 | metadata={"key": "value"}, |
| 754 | + ml_repo="ml_repo", |
905 | 755 | source=TrueFoundryManagedSource(), |
906 | 756 | ), |
907 | 757 | ) |
@@ -1152,15 +1002,17 @@ for page in response.iter_pages(): |
1152 | 1002 | <dd> |
1153 | 1003 |
|
1154 | 1004 | ```python |
1155 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 1005 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
1156 | 1006 |
|
1157 | 1007 | client = TrueFoundry( |
1158 | 1008 | api_key="YOUR_API_KEY", |
1159 | 1009 | base_url="https://yourhost.com/path/to/api", |
1160 | 1010 | ) |
1161 | 1011 | client.v1.tools.create_or_update( |
1162 | | - manifest=Model( |
| 1012 | + manifest=ModelManifest( |
| 1013 | + name="name", |
1163 | 1014 | metadata={"key": "value"}, |
| 1015 | + ml_repo="ml_repo", |
1164 | 1016 | source=TrueFoundryManagedSource(), |
1165 | 1017 | ), |
1166 | 1018 | ) |
@@ -1419,15 +1271,17 @@ for page in response.iter_pages(): |
1419 | 1271 | <dd> |
1420 | 1272 |
|
1421 | 1273 | ```python |
1422 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 1274 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
1423 | 1275 |
|
1424 | 1276 | client = TrueFoundry( |
1425 | 1277 | api_key="YOUR_API_KEY", |
1426 | 1278 | base_url="https://yourhost.com/path/to/api", |
1427 | 1279 | ) |
1428 | 1280 | client.v1.models.create_or_update( |
1429 | | - manifest=Model( |
| 1281 | + manifest=ModelManifest( |
| 1282 | + name="name", |
1430 | 1283 | metadata={"key": "value"}, |
| 1284 | + ml_repo="ml_repo", |
1431 | 1285 | source=TrueFoundryManagedSource(), |
1432 | 1286 | ), |
1433 | 1287 | ) |
@@ -1894,15 +1748,17 @@ client.v1.artifact_versions.create_multi_part_upload( |
1894 | 1748 | <dd> |
1895 | 1749 |
|
1896 | 1750 | ```python |
1897 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 1751 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
1898 | 1752 |
|
1899 | 1753 | client = TrueFoundry( |
1900 | 1754 | api_key="YOUR_API_KEY", |
1901 | 1755 | base_url="https://yourhost.com/path/to/api", |
1902 | 1756 | ) |
1903 | 1757 | client.v1.artifact_versions.stage( |
1904 | | - manifest=Model( |
| 1758 | + manifest=ModelManifest( |
| 1759 | + name="name", |
1905 | 1760 | metadata={"key": "value"}, |
| 1761 | + ml_repo="ml_repo", |
1906 | 1762 | source=TrueFoundryManagedSource(), |
1907 | 1763 | ), |
1908 | 1764 | ) |
@@ -3368,15 +3224,17 @@ for page in response.iter_pages(): |
3368 | 3224 | <dd> |
3369 | 3225 |
|
3370 | 3226 | ```python |
3371 | | -from truefoundry_sdk import Model, TrueFoundry, TrueFoundryManagedSource |
| 3227 | +from truefoundry_sdk import ModelManifest, TrueFoundry, TrueFoundryManagedSource |
3372 | 3228 |
|
3373 | 3229 | client = TrueFoundry( |
3374 | 3230 | api_key="YOUR_API_KEY", |
3375 | 3231 | base_url="https://yourhost.com/path/to/api", |
3376 | 3232 | ) |
3377 | 3233 | client.v1.data_directories.create_or_update( |
3378 | | - manifest=Model( |
| 3234 | + manifest=ModelManifest( |
| 3235 | + name="name", |
3379 | 3236 | metadata={"key": "value"}, |
| 3237 | + ml_repo="ml_repo", |
3380 | 3238 | source=TrueFoundryManagedSource(), |
3381 | 3239 | ), |
3382 | 3240 | ) |
|
0 commit comments