Skip to content

Commit

Permalink
Merge branch 'develop' into fix/model_get_artifact_latest_version
Browse files Browse the repository at this point in the history
  • Loading branch information
schustmi committed Feb 11, 2025
2 parents 0843510 + 47be36f commit d35d581
Show file tree
Hide file tree
Showing 41 changed files with 791 additions and 259 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs_summarization_submit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
mv repomix-output.txt getting-started.txt
# Merge user guide and getting started into basics
cat user-guide.txt getting-started.txt > repomix-outputs/basics.txt
cat user-guide.txt getting-started.txt > repomix-outputs/llms.txt
rm user-guide.txt getting-started.txt
- name: Upload repomix outputs
uses: actions/upload-artifact@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release_prepare.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
# Update the README, pyproject.toml, version and helm files
- name: Update main files
run: |
sed -i "s/${{ needs.fetch-versions.outputs.old_version }}/${{ needs.fetch-versions.outputs.new_version }}/g" README.md pyproject.toml helm/Chart.yaml helm/README.md
sed -i "s/${{ needs.fetch-versions.outputs.old_version }}/${{ needs.fetch-versions.outputs.new_version }}/g" README.md pyproject.toml src/zenml/VERSION helm/Chart.yaml helm/README.md
git add README.md pyproject.toml src/zenml/VERSION helm/Chart.yaml helm/README.md
# Update the Quickstart references
- name: Replace the references in the quickstart example
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ the Apache License Version 2.0.
<a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
<br />
<br />
🎉 Version 0.73.0 is out. Check out the release notes
🎉 Version 0.74.0 is out. Check out the release notes
<a href="https://github.com/zenml-io/zenml/releases">here</a>.
<br />
🖥️ Download our VS Code Extension <a href="https://marketplace.visualstudio.com/items?itemName=ZenML.zenml-vscode">here</a>.
Expand Down
95 changes: 95 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,100 @@
<!-- markdown-link-check-disable -->

# 0.74.0

The `0.74.0` release introduces several major features including [SageMaker
pipeline scheduling capabilities](https://docs.zenml.io/stack-components/orchestrators/sagemaker#scheduling-pipelines),
[Azure Container Registry (ACR) implicit authentication support](https://docs.zenml.io/stack-components/container-registries/azure#authentication-methods),
and [Vertex AI persistent resource handling for step operators](https://docs.zenml.io/stack-components/step-operators/vertex#using-persistent-resources-for-faster-development).
Additionally, this release includes comprehensive improvements
to timezone handling and significant enhancements to database performance.

## Features

- API Tokens support in the dashboard for time-boxed API authentication
- [SageMaker pipeline scheduling capabilities](https://docs.zenml.io/stack-components/orchestrators/sagemaker#scheduling-pipelines)
- [Azure Container Registry (ACR) and Storage Account implicit authentication](https://docs.zenml.io/stack-components/container-registries/azure#authentication-methods)
- [Vertex AI persistent resource support](https://docs.zenml.io/stack-components/step-operators/vertex#using-persistent-resources-for-faster-development) for step operators
- Support for [custom log formats](https://docs.zenml.io/how-to/control-logging/set-logging-format)
- Run metadata and tag indices for improved performance
- [Core concepts video added to documentation](https://docs.zenml.io/getting-started/core-concepts)

## Improvements

- Comprehensive timezone consistency improvements across the platform
- Enhanced database query performance for pipelines, run templates, models,
and artifacts
- Better handling of configured parameters during pipeline preparation
- Support for passing run configurations as dictionaries when triggering
pipelines
- Enhanced sorting capabilities for columns with empty values in the dashboard
- Improved queries for pipelines, run templates, models, and artifacts
- Better filtering functionality for run metadata
- More efficient artifact filtering
- Various Helm chart improvements and reorganization
- Updated materializer support for newer PyTorch versions
- Improved code repository management and downloading
- Better handling of `SecretStr` values in store configurations

## Fixes

- Kubernetes service connector issues resolved
- Fixed sorting for columns with potentially empty values
- Corrected timestamp utilization for better timezone consistency
- Resolved issues with vLLM pipeline config file usage
- Fixed code download functionality for custom flavor components
- Addressed various documentation and broken links
- Corrected MySQL database connection warnings
- Fixed issues with Vertex AI experiment tracker documentation

## What's Changed

* Fix some docs by @htahir1 in https://github.com/zenml-io/zenml/pull/3302
* Replace deprecated `datetime.utcnow()` with `datetime.now(timezone.utc)` by @aiakide in https://github.com/zenml-io/zenml/pull/3265
* Adding the missing VertexAI experiment tracker docs by @bcdurak in https://github.com/zenml-io/zenml/pull/3308
* Create Sagemaker pipeline schedules if specified by @htahir1 in https://github.com/zenml-io/zenml/pull/3271
* Formatting by @schustmi in https://github.com/zenml-io/zenml/pull/3307
* Remove trailing slashes from zenml login URLs by @stefannica in https://github.com/zenml-io/zenml/pull/3312
* Fix Kubernetes service connector by @stefannica in https://github.com/zenml-io/zenml/pull/3313
* Add notes on missing features for on-prem ZenML Pro deployments by @stefannica in https://github.com/zenml-io/zenml/pull/3301
* Fix wrong warning log when directly connecting to MySQL DB by @schustmi in https://github.com/zenml-io/zenml/pull/3311
* Fix typo by @schustmi in https://github.com/zenml-io/zenml/pull/3316
* Minor fix for Sagemaker by @bcdurak in https://github.com/zenml-io/zenml/pull/3318
* Rework timestamp utilization for timezone consistency by @stefannica in https://github.com/zenml-io/zenml/pull/3314
* Add broken links checker by @htahir1 in https://github.com/zenml-io/zenml/pull/3305
* Schedule timezone fixes by @schustmi in https://github.com/zenml-io/zenml/pull/3315
* Misc code repository improvements by @schustmi in https://github.com/zenml-io/zenml/pull/3306
* Add core concepts video by @htahir1 in https://github.com/zenml-io/zenml/pull/3324
* Fix code download for custom flavor components by @schustmi in https://github.com/zenml-io/zenml/pull/3323
* Allow passing run configuration as dict when triggering pipelines by @schustmi in https://github.com/zenml-io/zenml/pull/3326
* Fix sorting by columns with potentially empty values by @schustmi in https://github.com/zenml-io/zenml/pull/3325
* Allow custom log formats by @schustmi in https://github.com/zenml-io/zenml/pull/3288
* Add vertex persistent resource to settings for step operator by @htahir1 in https://github.com/zenml-io/zenml/pull/3304
* Fix use of config file in vLLM pipelines by @wjayesh in https://github.com/zenml-io/zenml/pull/3322
* Fixing the CI with the new `huggingface-hub` version by @bcdurak in https://github.com/zenml-io/zenml/pull/3329
* Handling string values as SecretStrs in store configurations by @bcdurak in https://github.com/zenml-io/zenml/pull/3319
* More code repository improvements by @schustmi in https://github.com/zenml-io/zenml/pull/3327
* Fix materializer for new pytorch version by @schustmi in https://github.com/zenml-io/zenml/pull/3331
* Add some nicer docs by @htahir1 in https://github.com/zenml-io/zenml/pull/3328
* Add run metadata and tag indices by @schustmi in https://github.com/zenml-io/zenml/pull/3310
* Fix markdown link checker for external PRs by @schustmi in https://github.com/zenml-io/zenml/pull/3333
* feat: implement implicit authentication for ACR and Storage Account by @lukas-reining in https://github.com/zenml-io/zenml/pull/3274
* Add support for symlinks in GH download by @schustmi in https://github.com/zenml-io/zenml/pull/3332
* ZenML Helm chart improvements by @stefannica in https://github.com/zenml-io/zenml/pull/3320
* Move helm chart out of the source tree by @stefannica in https://github.com/zenml-io/zenml/pull/3338
* Add option to skip stack validation by @schustmi in https://github.com/zenml-io/zenml/pull/3337
* Improve queries for pipelines, run templates, models and artifacts by @schustmi in https://github.com/zenml-io/zenml/pull/3335
* Improve configured parameter detection when preparing pipeline by @schustmi in https://github.com/zenml-io/zenml/pull/3339
* Minor fix for the Artifact filter model by @bcdurak in https://github.com/zenml-io/zenml/pull/3334
* Allow (un)installing integrations with system-wide uv installations by @schustmi in https://github.com/zenml-io/zenml/pull/3342
* Fix filtering by run metadata by @schustmi in https://github.com/zenml-io/zenml/pull/3344

## New Contributors

* @lukas-reining made their first contribution in https://github.com/zenml-io/zenml/pull/3274

**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.73.0...0.74.0

# 0.73.0

The `0.73.0` release contains various changes and improvements, but most
Expand Down
Binary file added docs/book/.gitbook/assets/llms-txt-thumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/book/.gitbook/assets/vertexai_experiment_tracker_tb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/book/.gitbook/assets/vertexai_experiment_tracker_ui.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.
51 changes: 50 additions & 1 deletion docs/book/getting-started/zenml-pro/pro-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,56 @@ you can use the same browser window to authenticate requests to your ZenML Pro A
For example, for the SaaS variant, you can access the docs here: [https://cloudapi.zenml.io](https://cloudapi.zenml.io). You can make requests
by being logged into ZenML Pro at [https://cloud.zenml.io](https://cloud.zenml.io).

Programmatic access is not possible at the moment.
### Programmatic access with API tokens

API tokens provide a way to authenticate with the ZenML Pro API for temporary automation tasks. These tokens are scoped to your user account and are valid for 1 hour by default. You can use the generated API tokens for programmatic access to the ZenML Pro REST API.

To generate a new API token for the ZenML Pro API:

1. Navigate to the organization settings page in your ZenML Pro dashboard
2. Select "API Tokens" from the left sidebar

![API Tokens](../../.gitbook/assets/zenml-pro-api-token-01.png)

3. Click the "Create new token" button. Once generated, you'll see a dialog showing your new API token.

![API Tokens](../../.gitbook/assets/zenml-pro-api-token-02.png)

4. Simply use the API token as the bearer token in your HTTP requests. For example, you can use the following command to check your current user:
* using curl:
```bash
curl -H "Authorization: Bearer YOUR_API_TOKEN" https://cloudapi.zenml.io/users/me
```
* using wget:
```bash
wget -qO- --header="Authorization: Bearer YOUR_API_TOKEN" https://cloudapi.zenml.io/users/me
```
* using python:
```python
import requests
response = requests.get(
"https://cloudapi.zenml.io/users/me",
headers={"Authorization": f"Bearer YOUR_API_TOKEN"}
)
print(response.json())
```

{% hint style="info" %}
**Important Notes**

- API tokens expire after 1 hour and cannot be retrieved after initial generation
- Tokens are scoped to your user account and inherit your permissions
{% endhint %}

### Tenant programmatic access

Programmatic access to the ZenML Pro tenant API is achieved essentially the same way as the ZenML OSS server API. You can use one of these two methods:

* [Generate and use temporary API tokens](../../reference/api-reference.md#using-a-short-lived-api-token)
* [Create a service account and use its API key](../../reference/api-reference.md#using-a-service-account-and-an-api-key)

Please consult the indicated sections for more information.

## Key API Endpoints

Expand Down
Loading

0 comments on commit d35d581

Please sign in to comment.