Skip to content
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.

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

Adding the latest version id and name to the artifact response #2430

Merged
merged 10 commits into from
Feb 12, 2024

Conversation

bcdurak
Copy link
Contributor

@bcdurak bcdurak commented Feb 8, 2024

Describe changes

I added the latest version ID and name to the artifact response.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

Summary by CodeRabbit

  • Documentation

    • Added a new section for "HyperAI Orchestrator" in the documentation.
  • New Features

    • Renamed the "Airflow" integration to "HyperAI."
    • Enhanced Slack integration to prioritize default channel configuration.
    • Introduced new properties for artifacts to display their latest version name and ID.
  • Tests

    • Updated tests to include new artifact versioning fields.

@bcdurak bcdurak requested a review from strickvl February 8, 2024 15:28
Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The recent updates introduce a new section for the "HyperAI Orchestrator" in the documentation, rename the "Airflow" integration to "HyperAI", and improve the handling of Slack channel IDs in alerts. Additionally, enhancements are made to artifact version tracking by adding properties for the latest version name and ID. The testing scripts for MariaDB and MySQL migrations are also updated to include a new version.

Changes

Files Summary
docs/book/toc.md, scripts/.../test-migrations-mariadb.sh, scripts/.../test-migrations-mysql.sh Added "HyperAI Orchestrator" section to TOC; updated scripts to test version 0.55.2.
src/zenml/.../__init__.py Renamed "Airflow" integration to "HyperAI".
src/zenml/.../slack_alerter.py Modified _get_channel_id to prioritize default_slack_channel_id over slack_channel_id.
src/zenml/models/v2/core/artifact.py, src/zenml/.../artifact_schemas.py Added latest_version_name and latest_version_id properties with logic to retrieve latest version details.
tests/unit/conftest.py Added latest_version_name and latest_version_id with dynamic values to sample_artifact_model.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Feb 8, 2024
@strickvl
Copy link
Contributor

strickvl commented Feb 8, 2024

@coderabbitai review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 0207fc7 and 6264b05.
Files selected for processing (8)
  • docs/book/toc.md (1 hunks)
  • scripts/test-migrations-mariadb.sh (1 hunks)
  • scripts/test-migrations-mysql.sh (1 hunks)
  • src/zenml/integrations/hyperai/flavors/init.py (1 hunks)
  • src/zenml/integrations/slack/alerters/slack_alerter.py (2 hunks)
  • src/zenml/models/v2/core/artifact.py (3 hunks)
  • src/zenml/zen_stores/schemas/artifact_schemas.py (1 hunks)
  • tests/unit/conftest.py (1 hunks)
Additional comments: 7
scripts/test-migrations-mariadb.sh (1)
  • 42-42: The addition of version 0.55.2 to the list of versions to test is consistent with the PR objectives.
scripts/test-migrations-mysql.sh (1)
  • 61-61: The inclusion of version 0.55.2 in the list of versions to test aligns with the PR objectives.
src/zenml/models/v2/core/artifact.py (2)
  • 76-77: Adding latest_version_name and latest_version_id as optional properties in ArtifactResponseBody is correct and aligns with the PR objectives.
  • 119-135: The implementation of getter methods for latest_version_name and latest_version_id is correct, ensuring these new properties are accessible as intended.
src/zenml/integrations/slack/alerters/slack_alerter.py (1)
  • 121-122: Modifying the _get_channel_id function to prioritize default_slack_channel_id over slack_channel_id when both are available is a logical enhancement for flexibility in configuration.
src/zenml/zen_stores/schemas/artifact_schemas.py (1)
  • 112-123: Implementing logic to retrieve and include latest_version_name and latest_version_id in ArtifactResponseBody based on the latest version from self.versions is correct and supports the PR's objective of enhancing artifact responses.
docs/book/toc.md (1)
  • 97-97: Adding a new section for "HyperAI Orchestrator" in the table of contents is consistent with the documentation update mentioned in the PR objectives.

tests/unit/conftest.py Outdated Show resolved Hide resolved
@bcdurak bcdurak marked this pull request as ready for review February 9, 2024 08:01
@bcdurak bcdurak merged commit b4f844f into develop Feb 12, 2024
55 checks passed
@bcdurak bcdurak deleted the feature/OSSK-413-add-latest-version-to-artifact branch February 12, 2024 15:59
avishniakov added a commit that referenced this pull request Feb 21, 2024
* Fix conditional statements in GitHub workflows (#2404)

* Fix conditional statements in GitHub workflows

* rename core CI flows

* slow CI check doesn't happen when draft

* Auto-update of Starter template

* fix double conditional

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Ensure proper spacing in error messages (#2399)

* Ensure proper spacing in error messages

* update TOC (#2406)

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Fix hyperai markdown table (#2426)

* build: ⬆️ Upgrade min required google-cloud-aiplatform to 1.34.0 (#2428)

* Close code block left open in the docs (#2432)

* Fix docs

* wrong ticks!

* Simplify HF example and notify when cache is down (#2300)

* starter files for the new CI paradigm

* disable fast/slow ci on base branch

* disable core workflow

* Fast/slow CI core scaffold (#2274)

* give darglint check its own job

* fastCI

* add slowCI

* reenable fast CI

* remove comment

* add integration tests

* fix spellcheck context

* enable slow CI for testing

* remove unit test dependency

* fix dependency installations

* yamlfixed

* Comment-driven CI (#2275)

* test comment-driven approach

* delete unused test file

* slow CI is comment-driven

* restore CI

* conditionally respond to comments depending on team status

* add the whole team

* Update .github/workflows/ci-slow.yml

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

* delete old CI

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

* remove spellcheck from slow CI

* update spellcheck run conditions

* Add GitHub issue creation on cache miss

* test failing cache

* Update Minio endpoint in setup_environment action.yml

* Update minio-service endpoint in setup_environment action.yml

* Sharded integration tests for Ubuntu (#2286)

* add pytest-shard dev dependency

* update script for sharded testing

* add ubuntu sharding

* fix naming

* Use `pytest-split` to shard CI (#2296)

* add split test to action

* Update user authentication logic

* Fix bug in login functionality

* Refactor test coverage script

* Update excluded directories in pyproject.toml

* Update integration test script to include shard number

* Update integration test script to use matrix.shard

* Update caching key in setup_environment action.yml

* Update durations path in test-coverage-xml.sh

* Update cache key in setup_environment action.yml

* Auto-update of Starter template

* Fix formatting issue in setup_environment action.yml

* Refactor code to improve performance and readability

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Update pyproject.toml

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* add extra final line

* make workflows use normal ubuntu)

* fix durations path and update docstring

---------

Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>

* Auto-update of Starter template

* Auto-update of NLP template

* Auto-update of E2E template

* add docker testing back in

* Auto-update of E2E template

* temporarily trigger slow CI

* revert to comment-driven CI

* run full slow CI

* CI as it should be

* pyyaml fix

* fix docker compose installation

* test

* test

* update templates test

* ubuntu-unit tests

* restore unit tests back to normal

* fix matrix for slow CI

* uncomment the conditional checks

* add input variable

* remove mac and windows for testing

* split out slow and fast integration testing

* naming fix

* confirm mac and windows ok"

* improve hf and neuralprofet example

* update the issue

* update TOC (#2406)

* Correct docstring in integration init file (#2408)

* Fixed precedence

* adding the new version to the migration tests (#2411)

* update js code for github cache miss

* update context to github

* add discord webhooks

* Add Discord webhook support for notifications

* allow fallback of cache failure

* ignore if weebhock fails to to many request

* Add PYTORCH integration to DockerSettings

---------

Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>
Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

* Adding the latest version id and name to the artifact response (#2430)

* update TOC (#2406)

* Correct docstring in integration init file (#2408)

* Fixed precedence

* adding the new version to the migration tests (#2411)

* adding latest version name and id to artifact response

* removed optional column from the conftest

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>

* Adding the ID of the producer pipeline run to artifact versions (#2431)

* adding producer pipeline run id to artifact versions

* reverting one of the changes

* fixing type

* Add vulnerability notice to README (#2437)

* Add security vulnerability notice to README

* add CVE ID

* Allow more recent `adlfs` and `s3fs` versions (#2402)

* bump azure integration

* bump s3

* Add new property for filtering service account events (#2405)

* add new property for filtering service account activities

* Auto-update of Starter template

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Add `download_files` method for `ArtifactVersion` (#2434)

* add save_binary method

* Fix file overwrite issue in save_artifact_binary_from_response() and improve error handling

* refactor

* tests ofc

* add docs

* linting

* mypy fixes

* ruff fix

* coderabbit suggestions

* missing docstring

* docstring fix

* Update artifact method name from save_binary to download_binary

* more renaming (save -> download)

* final rename (binary -> files)

* update settings syntax

* Fixing `update_model`s and revert #2402 (#2440)

* fixing update models

* reverting the update model changes

* linting

* linting

* revert #2402

* revert adlfs changes

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>
Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>

* Prepare release 0.55.3 (#2445)

* alembic migration and bump version

* release notes

* add `save_models_to_registry` to CLI

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: François SERRA <francois.serra@adeo.com>
Co-authored-by: jlopezpena <jlopezpena@users.noreply.github.com>
Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>
Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>
Co-authored-by: Jayesh Sharma <wjayesh@outlook.com>
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
…-io#2430)

* update TOC (zenml-io#2406)

* Correct docstring in integration init file (zenml-io#2408)

* Fixed precedence

* adding the new version to the migration tests (zenml-io#2411)

* adding latest version name and id to artifact response

* removed optional column from the conftest

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
…l-io#2447)

* Fix conditional statements in GitHub workflows (zenml-io#2404)

* Fix conditional statements in GitHub workflows

* rename core CI flows

* slow CI check doesn't happen when draft

* Auto-update of Starter template

* fix double conditional

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Ensure proper spacing in error messages (zenml-io#2399)

* Ensure proper spacing in error messages

* update TOC (zenml-io#2406)

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Fix hyperai markdown table (zenml-io#2426)

* build: ⬆️ Upgrade min required google-cloud-aiplatform to 1.34.0 (zenml-io#2428)

* Close code block left open in the docs (zenml-io#2432)

* Fix docs

* wrong ticks!

* Simplify HF example and notify when cache is down (zenml-io#2300)

* starter files for the new CI paradigm

* disable fast/slow ci on base branch

* disable core workflow

* Fast/slow CI core scaffold (zenml-io#2274)

* give darglint check its own job

* fastCI

* add slowCI

* reenable fast CI

* remove comment

* add integration tests

* fix spellcheck context

* enable slow CI for testing

* remove unit test dependency

* fix dependency installations

* yamlfixed

* Comment-driven CI (zenml-io#2275)

* test comment-driven approach

* delete unused test file

* slow CI is comment-driven

* restore CI

* conditionally respond to comments depending on team status

* add the whole team

* Update .github/workflows/ci-slow.yml

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

* delete old CI

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

* remove spellcheck from slow CI

* update spellcheck run conditions

* Add GitHub issue creation on cache miss

* test failing cache

* Update Minio endpoint in setup_environment action.yml

* Update minio-service endpoint in setup_environment action.yml

* Sharded integration tests for Ubuntu (zenml-io#2286)

* add pytest-shard dev dependency

* update script for sharded testing

* add ubuntu sharding

* fix naming

* Use `pytest-split` to shard CI (zenml-io#2296)

* add split test to action

* Update user authentication logic

* Fix bug in login functionality

* Refactor test coverage script

* Update excluded directories in pyproject.toml

* Update integration test script to include shard number

* Update integration test script to use matrix.shard

* Update caching key in setup_environment action.yml

* Update durations path in test-coverage-xml.sh

* Update cache key in setup_environment action.yml

* Auto-update of Starter template

* Fix formatting issue in setup_environment action.yml

* Refactor code to improve performance and readability

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Update pyproject.toml

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* add extra final line

* make workflows use normal ubuntu)

* fix durations path and update docstring

---------

Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>

* Auto-update of Starter template

* Auto-update of NLP template

* Auto-update of E2E template

* add docker testing back in

* Auto-update of E2E template

* temporarily trigger slow CI

* revert to comment-driven CI

* run full slow CI

* CI as it should be

* pyyaml fix

* fix docker compose installation

* test

* test

* update templates test

* ubuntu-unit tests

* restore unit tests back to normal

* fix matrix for slow CI

* uncomment the conditional checks

* add input variable

* remove mac and windows for testing

* split out slow and fast integration testing

* naming fix

* confirm mac and windows ok"

* improve hf and neuralprofet example

* update the issue

* update TOC (zenml-io#2406)

* Correct docstring in integration init file (zenml-io#2408)

* Fixed precedence

* adding the new version to the migration tests (zenml-io#2411)

* update js code for github cache miss

* update context to github

* add discord webhooks

* Add Discord webhook support for notifications

* allow fallback of cache failure

* ignore if weebhock fails to to many request

* Add PYTORCH integration to DockerSettings

---------

Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>
Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

* Adding the latest version id and name to the artifact response (zenml-io#2430)

* update TOC (zenml-io#2406)

* Correct docstring in integration init file (zenml-io#2408)

* Fixed precedence

* adding the new version to the migration tests (zenml-io#2411)

* adding latest version name and id to artifact response

* removed optional column from the conftest

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>

* Adding the ID of the producer pipeline run to artifact versions (zenml-io#2431)

* adding producer pipeline run id to artifact versions

* reverting one of the changes

* fixing type

* Add vulnerability notice to README (zenml-io#2437)

* Add security vulnerability notice to README

* add CVE ID

* Allow more recent `adlfs` and `s3fs` versions (zenml-io#2402)

* bump azure integration

* bump s3

* Add new property for filtering service account events (zenml-io#2405)

* add new property for filtering service account activities

* Auto-update of Starter template

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Add `download_files` method for `ArtifactVersion` (zenml-io#2434)

* add save_binary method

* Fix file overwrite issue in save_artifact_binary_from_response() and improve error handling

* refactor

* tests ofc

* add docs

* linting

* mypy fixes

* ruff fix

* coderabbit suggestions

* missing docstring

* docstring fix

* Update artifact method name from save_binary to download_binary

* more renaming (save -> download)

* final rename (binary -> files)

* update settings syntax

* Fixing `update_model`s and revert zenml-io#2402 (zenml-io#2440)

* fixing update models

* reverting the update model changes

* linting

* linting

* revert zenml-io#2402

* revert adlfs changes

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>
Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>

* Prepare release 0.55.3 (zenml-io#2445)

* alembic migration and bump version

* release notes

* add `save_models_to_registry` to CLI

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Christian Versloot <c.versloot@infoplaza.nl>
Co-authored-by: François SERRA <francois.serra@adeo.com>
Co-authored-by: jlopezpena <jlopezpena@users.noreply.github.com>
Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: Alex Strick van Linschoten <stricksubscriptions@fastmail.fm>
Co-authored-by: Hamza Tahir <htahir111@gmail.com>
Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>
Co-authored-by: Jayesh Sharma <wjayesh@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal To filter out internal PRs and issues run-slow-ci
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants