8000 docs(FIFTYONE_MEDIA_CACHE_SIZE_BYTES): replace the erroneous behavior… by kevin-dimichel · Pull Request #5905 · voxel51/fiftyone · GitHub
[go: up one dir, main page]
Skip to content

docs(FIFTYONE_MEDIA_CACHE_SIZE_BYTES): replace the erroneous behavior… #5905

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 13, 2025
Merged

docs(FIFTYONE_MEDIA_CACHE_SIZE_BYTES): replace the erroneous behavior… #5905

merged 1 commit into from
May 13, 2025

Conversation

kevin-dimichel
Copy link
Contributor
@kevin-dimichel kevin-dimichel commented May 13, 2025 •
edited by coderabbitai bot
Loading

What changes are proposed in this pull request?

cherry-pick #5904 (3db1b92b9163ffa374717ee8cf60a7ebed37762a) to the release/v1.6.0 branch for release.

How is this patch tested? If it is not, please explain why.

n/s

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • Documentation
    • Clarified instructions and improved wording regarding disabling the media cache cleanup service.
    • Expanded explanation for the environment variable that disables media cache garbage collection and sets the cache size to unlimited.

@kevin-dimichel
docs(FIFTYONE_MEDIA_CACHE_SIZE_BYTES): replace the erroneous behavior…
ed62bd2 
… description around the media cache. (#5904)

docs(FIFTYONE_MEDIA_CACHE_SIZE_BYTES): describe actual behavior: (`-1` means disable garbage collection [not disable media cache]).
@kevin-dimichel kevin-dimichel requested a review from a team as a code owner May 13, 2025 18:07
@coderabbitai coderabbitai
8000
Copy link
Contributor
coderabbitai bot commented May 13, 2025 •
edited
Loading

Walkthrough

The documentation for the "AWS Lambda and Google Cloud Functions" section was updated to clarify the instructions regarding disabling the media cache cleanup service. The language was corrected and the comment about the relevant environment variable was expanded for greater clarity.

Changes

File(s) Change Summary
docs/source/enterprise/cloud_media.rst Clarified documentation text and comments about disabling the media cache cleanup service and updated the description of the environment variable.

Poem

In the docs a tweak was made,
To clear up what the cache parade—
No more confusion, now it’s bright,
The cleanup service set just right.
With clearer words, the meaning’s true,
Hopping forward, docs renewed!
🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot]
coderabbitai bot reviewed May 13, 2025
View reviewed changes
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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/source/enterprise/cloud_media.rst (1)

873-880: Fix extraneous article and clarify description
The phrase on line 873 currently reads “disable the media the cache cleanup service,” which contains an extra “the” and could be clearer. Consider rephrasing to explicitly name AWS Lambda and Google Cloud Functions and note their inability to run background services. For example:

-Lambda/GCFs cannot use services, so you must disable the media the cache cleanup
-service by setting the following runtime environment variable.
+Because AWS Lambda and Google Cloud Functions cannot run background services,
+you must disable the media cache cleanup service by setting the following
+runtime environment variable:
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 87b9d6c and ed62bd2.

📒 Files selected for processing (1)
  • docs/source/enterprise/cloud_media.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

@kevin-dimichel kevin-dimichel merged commit 121508a into release/v1.6.0 May 13, 2025
11 checks passed
@kevin-dimichel kevin-dimichel deleted the kevin/cherry-pick-docs-media-cache branch May 13, 2025 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jleven jleven jleven approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kevin-dimichel @jleven
0