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

Lazy loading improvements #3140

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

schustmi
Copy link
Contributor

Describe changes

This is still a draft which contains some questions that need to be answered first before any improvements can be implemented.

Current improvement ideas:

  • Separate the object that does the client lazy loading evaluation from the object that we store in the configuration
    • The overwriting of __getattr__ and __call__ has some nasty interactions with pydantic methods, which have previously caused some bugs
  • Make lazy loading an explicit behaviour (e.g. a lazy: bool = False argument on the client methods that support it). Right now it is very intransparent what's happening.
  • In addition to the previous point, we could introduce explicit lazy responses for the client methods, which would only have the subset of methods that make sense for these lazy evaluations. This makes it less generic but also causes less issues at runtime.
  • Maybe make lazy loadings for models also more transparent by having for example a LazyModel class that gets returned by PipelineContext.model?

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)

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Important

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>, please review it.
    • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Oct 24, 2024
@@ -208,6 +208,9 @@ def _inner(*args: Any, **kwargs: Any) -> Any:
with contextlib.suppress(ValueError):
kwargs[k] = ClientLazyLoader(**v).evaluate()

# Why do we check for `isinstance(v, ClientLazyLoader)` for the
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This works as expected and evaluates at runtime because intermediate it passed as an arg:

@pipeline(enable_cache=False, model=Model(name=MODEL_NAME))
def test_pipeline():
    intermediate = Client().get_model(MODEL_NAME).latest_version_id

    cll = (
        Client()
        .get_model_version(
            MODEL_NAME, intermediate
        )
        .get_artifact(ARTIFACT_NAME)
    )

If we pass it as a keyword argument instead, the intermediate lazy loader already gets evaluated at pipeline compilation time

@pipeline(enable_cache=False, model=Model(name=MODEL_NAME))
def test_pipeline():
    intermediate = Client().get_model(MODEL_NAME).latest_version_id

    cll = (
        Client()
        .get_model_version(
            MODEL_NAME, model_version_name_or_number_or_id=intermediate
        )
        .get_artifact(ARTIFACT_NAME)
    )

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@avishniakov I tried to understand the reason for the evaluate_all_lazy_load_args_in_client_methods decorator, and the only thing I could come up with were these nested lazy loaders. Then I ran into this issue with the args/kwargs and was wondering what the expected behaviour would be in your opinion

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant