Skip to content

🌿 Fern Regeneration -- March 2, 2025 #3

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.

Sign up for GitHub

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

Merged
chiragjn merged 1 commit into from
Mar 2, 2025
Merged

🌿 Fern Regeneration -- March 2, 2025 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 12 additions & 187 deletions reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,181 +60,6 @@ client.v1.apply(
</dl>


</dd>
</dl>
</details>

## Deprecated
<details><summary><code>client.deprecated.<a href="src/truefoundry/deprecated/client.py">get_search_runs_get</a>(...)</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from truefoundry import TrueFoundry

client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.deprecated.get_search_runs_get()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**filter:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**page_token:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]`

</dd>
</dl>

<dl>
<dd>

**run_view_type:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**max_results:** `typing.Optional[int]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.deprecated.<a href="src/truefoundry/deprecated/client.py">get_run_by_name_get</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get Run by run name
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from truefoundry import TrueFoundry

client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.deprecated.get_run_by_name_get(
run_name="run_name",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**run_name:** `str`

</dd>
</dl>

<dl>
<dd>

**experiment_id:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**experiment_name:** `typing.Optional[str]`

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>
Expand Down Expand Up @@ -541,7 +366,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.artifacts.<a href="src/truefoundry/v1/artifacts/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.artifacts.<a href="src/truefoundry/v1/artifacts/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -564,7 +389,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.artifacts.apply(
client.v1.artifacts.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down Expand Up @@ -804,7 +629,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.agents.<a href="src/truefoundry/v1/agents/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.agents.<a href="src/truefoundry/v1/agents/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -827,7 +652,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.agents.apply(
client.v1.agents.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down Expand Up @@ -1067,7 +892,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.prompts.<a href="src/truefoundry/v1/prompts/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.prompts.<a href="src/truefoundry/v1/prompts/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -1090,7 +915,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.prompts.apply(
client.v1.prompts.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down Expand Up @@ -1330,7 +1155,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.tools.<a href="src/truefoundry/v1/tools/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.tools.<a href="src/truefoundry/v1/tools/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -1353,7 +1178,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.tools.apply(
client.v1.tools.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down Expand Up @@ -1601,7 +1426,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.models.<a href="src/truefoundry/v1/models/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.models.<a href="src/truefoundry/v1/models/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -1624,7 +1449,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.models.apply(
client.v1.models.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down Expand Up @@ -3558,7 +3383,7 @@ for page in response.iter_pages():
</dl>
</details>

<details><summary><code>client.v1.data_directories.<a href="src/truefoundry/v1/data_directories/client.py">apply</a>(...)</code></summary>
<details><summary><code>client.v1.data_directories.<a href="src/truefoundry/v1/data_directories/client.py">create_or_update</a>(...)</code></summary>
<dl>
<dd>

Expand All @@ -3581,7 +3406,7 @@ client = TrueFoundry(
api_key="YOUR_API_KEY",
base_url="https://yourhost.com/path/to/api",
)
client.v1.data_directories.apply(
client.v1.data_directories.create_or_update(
manifest=ModelVersionManifest(
metadata={"key": "value"},
source=TrueFoundryManagedSource(),
Expand Down
21 changes: 1 addition & 20 deletions src/truefoundry/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
AssistantMessage,
BaseArtifactVersion,
BlobStorageReference,
BodyGetSearchRunsGet,
ChatPromptManifest,
ChatPromptManifestMessagesItem,
CodeFileData,
Expand Down Expand Up @@ -79,7 +78,6 @@
LocalModelSource,
Manifest,
Method,
MetricDto,
MimeType,
MlRepo,
MlRepoManifest,
Expand All @@ -95,18 +93,11 @@
Operation,
PaddleFramework,
Pagination,
ParamDto,
Parameters,
Prompt,
PromptVersion,
PyTorchFramework,
ResolveAgentAppResponse,
RunDataDto,
RunDto,
RunInfoDto,
RunResponseDto,
RunTagDto,
SearchRunsResponseDto,
SignedUrl,
SklearnFramework,
SklearnModelSchema,
Expand Down Expand Up @@ -137,7 +128,7 @@
XgBoostSerializationFormat,
)
from .errors import UnprocessableEntityError
from . import deprecated, health, v1
from . import health, v1
from .client import AsyncTrueFoundry, TrueFoundry
from .version import __version__

Expand All @@ -163,7 +154,6 @@
"AsyncTrueFoundry",
"BaseArtifactVersion",
"BlobStorageReference",
"BodyGetSearchRunsGet",
"ChatPromptManifest",
"ChatPromptManifestMessagesItem",
"CodeFileData",
Expand Down Expand Up @@ -221,7 +211,6 @@
"LocalModelSource",
"Manifest",
"Method",
"MetricDto",
"MimeType",
"MlRepo",
"MlRepoManifest",
Expand All @@ -237,18 +226,11 @@
"Operation",
"PaddleFramework",
"Pagination",
"ParamDto",
"Parameters",
"Prompt",
"PromptVersion",
"PyTorchFramework",
"ResolveAgentAppResponse",
"RunDataDto",
"RunDto",
"RunInfoDto",
"RunResponseDto",
"RunTagDto",
"SearchRunsResponseDto",
"SignedUrl",
"SklearnFramework",
"SklearnModelSchema",
Expand Down Expand Up @@ -280,7 +262,6 @@
"XgBoostModelSchema",
"XgBoostSerializationFormat",
"__version__",
"deprecated",
"health",
"v1",
]
Loading