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

Additional fields for track events #2507

Merged
merged 9 commits into from
Mar 13, 2024

Conversation

bcdurak
Copy link
Contributor

@bcdurak bcdurak commented Mar 8, 2024

Describe changes

I have added the timezone and locale information to the track events.

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

    • Updated the Google Colab link in the ZenML quickstart guide for improved accessibility to the correct notebook.
  • New Features

    • Enhanced analytics tracking to include timezone and language code information for better user experience analysis.

@bcdurak bcdurak requested a review from strickvl March 8, 2024 15:23
Copy link
Contributor

coderabbitai bot commented Mar 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 to ZenML include a modification in the quickstart guide, specifically updating the Google Colab notebook link for a more relevant example. Additionally, enhancements in analytics tracking have been introduced, including the ability to capture timezone and language code information, by importing and utilizing datetime and locale modules in the analytics context.

Changes

File Path Change Summary
examples/.../README.md Updated Google Colab link to point to run.ipynb from quickstart.ipynb.
src/zenml/.../context.py Added imports (datetime, locale) and tracking for timezone and language code.

🐰✨
In the land of code and Zen,
Changes come, now and then.
Links and locales, timezones too,
Enhancements made, for me and you.
Hop along, let's see what's new!
🎉🐾

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.
    • Open a follow-up GitHub issue for this discussion.
  • 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 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 Mar 8, 2024
Copy link
Contributor

github-actions bot commented Mar 8, 2024

Quickstart template updates in examples/quickstart have been pushed.

@strickvl strickvl changed the title additional fields for track events Additional fields for track events Mar 8, 2024
src/zenml/analytics/context.py Outdated Show resolved Hide resolved
@strickvl
Copy link
Contributor

strickvl commented Mar 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 edebc51 and e10c2a0.
Files selected for processing (2)
  • examples/quickstart/README.md (2 hunks)
  • src/zenml/analytics/context.py (2 hunks)
Additional comments: 2
examples/quickstart/README.md (1)
  • 27-27: The update to the Google Colab link in the README seems appropriate for directing users to the intended notebook. Please ensure the link is correct and functional.
src/zenml/analytics/context.py (1)
  • 20-21: The addition of datetime and locale imports supports the new functionality for tracking timezone and language code information effectively.

src/zenml/analytics/context.py Outdated Show resolved Hide resolved
@bcdurak bcdurak requested a review from strickvl March 11, 2024 08:29
Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

@strickvl strickvl merged commit 29814cd into develop Mar 13, 2024
55 checks passed
@strickvl strickvl deleted the feature/OSSK-465-analytics-modifications branch March 13, 2024 08:16
AlexejPenner pushed a commit that referenced this pull request Mar 18, 2024
* additional fields for track events

* formatting

* Auto-update of Starter template

* adding a few recommendations

* formatting

* Auto-update of Starter template

---------

Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
* additional fields for track events

* formatting

* Auto-update of Starter template

* adding a few recommendations

* formatting

* Auto-update of Starter template

---------

Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
AlexejPenner added a commit that referenced this pull request Mar 26, 2024
* Interact with feature gate

* Properly handle entitlement violations

* Apply suggestions from code review

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>
Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>

* Auto-update of Starter template

* Applied code reviews

* reformatted

* Reformatted

* Disable feature_gate when no source specified.

* Auto-update of Starter template

* Auto-update of E2E template

* Auto-update of NLP template

* Handle corrupted or empty global configuration file (#2508)

* Handle corrupted or empty global configuration file

* Auto-update of Starter template

---------

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

* Linted

* Add admin users notion (#2494)

* add admin users to OSS

* skip missing methods

* increase readability

* doc string

* lint

* lint

* missing arg

* add some edge-cases

* wip commit to carve out clean_client changes

* revert irrelevant changes

* revert irrelevant changes

* rework tests to run on rest

* Apply suggestions from code review

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Stefan Nica <stefan@zenml.io>

* polish test cases

* fix branching

* admin user mgmt CLI/Client

* close activation vulnerability

* revert rbac changes

* verify admin permissions in endpoints

* add `is_admin` to external users

* only reg users will be migrated as admins

* default is always admin

* extend tests

* lint

* default `is_admin` None

* Auto-update of Starter template

* review suggestions

* review suggestions

* calm down linter

* Update src/zenml/cli/user_management.py

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Apply suggestions from code review

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

* review suggestion

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: Stefan Nica <stefan@zenml.io>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* remove dashboard from gitignore (#2517)

* Colima / Homebrew fix (#2512)

* attempt fix

* Auto-update of Starter template

* colima qemu fix trial

* remove qemu

* logs

* logs better

* testing brew workaround

* try second possible fix for python gha

* actually apply the fix

* try the second possible solution for unbreaking python

* make the CI whole again

* linting

* fix python 3.11 on mac (test)

* one more attempt

* formatting

* different fix

* restore the CI to full glory (fixed now!)

---------

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

* remove extra env var assignment (#2518)

* Allow installing packages using UV (#2510)

* Allow installing packages using UV

* Auto-update of Starter template

* actually make it work

* Auto-update of Starter template

---------

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

* Additional fields for track events (#2507)

* additional fields for track events

* formatting

* Auto-update of Starter template

* adding a few recommendations

* formatting

* Auto-update of Starter template

---------

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

* Auto-update of Starter template

* Auto-update of NLP template

* Auto-update of E2E template

* Update src/zenml/zen_server/exceptions.py

Co-authored-by: Stefan Nica <stefan@zenml.io>

* Update src/zenml/zen_server/cloud_utils.py

Co-authored-by: Stefan Nica <stefan@zenml.io>

* Applied code review.

* Properly reformatted

* Reformatted

* Fixed test

* Fixed docstring

* Model deletion works now, fixed error message

* Show correct error message when creating models that exceed subscription limit

* Send resource id

* Auto-update of LLM Finetuning template

* Fix error

* Limit pipeline namespaces

* Remove billing url

* Linted

* Potential fix

---------

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>
Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Co-authored-by: Stefan Nica <stefan@zenml.io>
Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Jayesh Sharma <wjayesh@outlook.com>
Co-authored-by: Michael Schuster <schustmi@users.noreply.github.com>
Co-authored-by: Michael Schuster <michael.schuster.ffb@googlemail.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.

None yet

3 participants