Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
wjayesh committed Oct 3, 2024
1 parent 8e3a345 commit 10c7df6
Show file tree
Hide file tree
Showing 2,394 changed files with 170,562 additions and 0 deletions.
Binary file added fern/all/0.72.0/_assets/how-to/trigger-pipelines
Binary file not shown.
Binary file not shown.
13 changes: 13 additions & 0 deletions fern/all/0.72.0/_assets/logo/dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions fern/all/0.72.0/_assets/logo/light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions fern/all/0.72.0/_assets/logo/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@font-face {
font-family: 'Jakarta Sans';
src: url('https://m.autopilotapp.com/zenml/fonts/838143.ttf');
font-weight: 900;
font-style: normal;
font-display: swap;
}

h1,
h2,
h3 {
font-family: 'Jakarta Sans';
letter-spacing: normal !important;
}
Binary file added fern/all/0.72.0/_assets/secret-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added fern/all/0.72.0/_assets/sys-a-1.png
Binary file added fern/all/0.72.0/_assets/sys-a-2.png
Binary file added fern/all/0.72.0/_assets/sys-a-3.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-1.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-2.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-3.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-4.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-5.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int-7.png
Binary file added fern/all/0.72.0/_assets/user-guide/data-int.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-1.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-2.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-3.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-4.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-5.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m-6.png
Binary file added fern/all/0.72.0/_assets/user-guide/ev-m.png
Binary file added fern/all/0.72.0/_assets/user-guide/llms.png
Binary file added fern/all/0.72.0/_assets/user-guide/re-rank-2.png
Binary file added fern/all/0.72.0/_assets/user-guide/re-rank-3.png
Binary file added fern/all/0.72.0/_assets/user-guide/re-rank.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-1.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-2.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-3.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-4.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-5.png
Binary file added fern/all/0.72.0/_assets/user-guide/sy-6.gif
Binary file added fern/all/0.72.0/_assets/user-guide/sy.png
Binary file added fern/all/0.72.0/_assets/user-management.png
4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/actions/create-action.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/actions/create-action
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/actions/delete-action.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/actions/delete-action
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/actions/get-action.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/actions/get-action
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/actions/list-actions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/actions/list-actions
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/actions/update-action.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/actions/update-action
---

80 changes: 80 additions & 0 deletions fern/all/0.72.0/api/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: API reference
subtitle: See the ZenML API reference.
slug: api/api-reference
---


The ZenML server is a FastAPI application, therefore the OpenAPI-compliant docs are available at `/docs` or `/redoc` of your ZenML server:

In the local case (i.e. using `zenml up`, the docs are available on `http://127.0.0.1:8237/docs`)
<Frame caption="ZenML API docs">
<img src="../_assets/api-ref.png"/>
</Frame>

<Frame caption="ZenML API Redoc">
<img src="../_assets/api-ref-2.png"/>
</Frame>


## Using a bearer token to access the API programmatically

If you are using the ZenML server API using the above pages, it is enough to be logged in to your ZenML account in the same browser session. However, in order to do this programmatically, the following steps need to be followed:

1. Create a [service account](../usage/resource-data-management/connecting-to-zenml/connect-with-a-service-account.mdx):


```Bash
zenml service-account create myserviceaccount
```

This will print out the `<ZENML_API_KEY>`, you can use in the next command.

1. Get an access token by using the `/api/v1/login` endpoint:


```shell

curl -X 'POST' \

'/api/v1/login' \

-H 'accept: application/json' \

-H 'Content-Type: application/x-www-form-urlencoded' \

-d 'grant_type=zenml-api-key&username=&password='\''&client_id=&device_code='
```

This will return a response like this:


```shell
{

"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI3MGJjZTg5NC1hN2VjLTRkOTYtYjE1Ny1kOTZkYWY5ZWM2M2IiLCJpc3MiOiJmMGQ5NjI1Ni04YmQyLTQxZDctOWVjZi0xMmYwM2JmYTVlMTYiLCJhdWQiOiJmMGQ5NjI1Ni04YmQyLTQxZDctOWVjZi0xMmYwM2JmYTVlMTYiLCJleHAiOjE3MTk0MDk0NjAsImFwaV9rZXlfaWQiOiIzNDkyM2U0NS0zMGFlLTRkMjctODZiZS0wZGRhNTdkMjA5MDcifQ.ByB1ngCPtBenGE6UugsWC6Blga3qPqkAiPJUSFDR-u4",

"token_type": "bearer",

"expires_in": 3600,

"refresh_token": null,

"scope": null

}
```

1. Use the access token to make subsequent curl commands:


```shell
curl -X 'GET' \

'/api/v1/pipelines?hydrate=false&name=training' \

-H 'accept: application/json' \

-H 'Authorization: Bearer '
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/create-artifact-version
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/delete-artifact-version
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/get-artifact-version
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/get-artifact-visualization
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/list-artifact-versions
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/prune-artifact-versions
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifact_versions/update-artifact-version
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/artifacts/create-artifact.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifacts/create-artifact
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/artifacts/delete-artifact.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifacts/delete-artifact
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/artifacts/get-artifact.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifacts/get-artifact
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/artifacts/list-artifacts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifacts/list-artifacts
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/artifacts/update-artifact.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/artifacts/update-artifact
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/auth/api-token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/auth/api-token
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/auth/device-authorization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/auth/device-authorization
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/auth/logout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/auth/logout
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/auth/token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/auth/token
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/authorized_devices/delete-authorized-device
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/authorized_devices/get-authorization-device
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/authorized_devices/list-authorized-devices
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/authorized_devices/update-authorized-device
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/authorized_devices/verify-authorized-device
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/builds/delete-build.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/builds/delete-build
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/builds/get-build.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/builds/get-build
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/builds/list-builds.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/builds/list-builds
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/code_repositories/delete-code-repository
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/code_repositories/get-code-repository.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/code_repositories/get-code-repository
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/code_repositories/list-code-repositories
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/code_repositories/update-code-repository
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/deployments/delete-deployment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/deployments/delete-deployment
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/deployments/deployment-logs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/deployments/deployment-logs
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/deployments/get-deployment.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/deployments/get-deployment
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/deployments/list-deployments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/deployments/list-deployments
---

5 changes: 5 additions & 0 deletions fern/all/0.72.0/api/endpoint/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Create Plant
slug: api/endpoint/create
---

5 changes: 5 additions & 0 deletions fern/all/0.72.0/api/endpoint/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Delete Plant
slug: api/endpoint/delete
---

5 changes: 5 additions & 0 deletions fern/all/0.72.0/api/endpoint/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Get pipelines
slug: api/endpoint/get
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/event-sources/create-event-source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/event-sources/create-event-source
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/event-sources/delete-event-source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/event-sources/delete-event-source
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/event-sources/get-event-source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/event-sources/get-event-source
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/event-sources/list-event-sources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/event-sources/list-event-sources
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/event-sources/update-event-source.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/event-sources/update-event-source
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/create-flavor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/create-flavor
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/delete-flavor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/delete-flavor
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/get-flavor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/get-flavor
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/list-flavors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/list-flavors
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/sync-flavors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/sync-flavors
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/flavors/update-flavor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/flavors/update-flavor
---

4 changes: 4 additions & 0 deletions fern/all/0.72.0/api/health.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/health
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/model_version_artifacts/list-model-version-artifact-links
---

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
slug: api/model_version_pipeline_runs/list-model-version-pipeline-run-links
---

Loading

0 comments on commit 10c7df6

Please sign in to comment.