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

Add reranking section to LLMOps guide #2679

Merged
merged 12 commits into from
May 8, 2024
Merged

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented May 7, 2024

This pull request adds documentation on reranking in ZenML. It explains what reranking is, the types of rerankers, and the benefits of reranking in the context of Retrieval-Augmented Generation (RAG).

Live docs preview (@htahir1) here

@strickvl strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels May 7, 2024
Copy link
Contributor

coderabbitai bot commented May 7, 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.

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>.
    • 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 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 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.

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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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.

@strickvl strickvl marked this pull request as ready for review May 8, 2024 07:42
Copy link
Contributor

github-actions bot commented May 8, 2024

Images automagically compressed by Calibre's image-actions

Compression reduced images by 27.1%, saving 25.79 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/reranker_evaluation_metrics.png 95.02 KB 69.23 KB -27.1% View diff

209 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

Copy link
Contributor

@AlexejPenner AlexejPenner left a comment

Choose a reason for hiding this comment

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

Just one tiny thing

Copy link
Contributor

github-actions bot commented May 8, 2024

Images automagically compressed by Calibre's image-actions

Compression reduced images by 58.6%, saving 741.10 KB.

Filename Before After Improvement Visual comparison
docs/book/.gitbook/assets/reranking-evaluation.png 210.27 KB 113.86 KB -45.8% View diff
docs/book/.gitbook/assets/reranking-workflow.png 1.03 MB 408.91 KB -61.2% View diff

210 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

@strickvl strickvl merged commit 81cc853 into develop May 8, 2024
5 checks passed
@strickvl strickvl deleted the doc/reranker-llmops-guide branch May 8, 2024 12:55
strickvl added a commit that referenced this pull request May 8, 2024
* add docs on rerankers

* update toc

* add try it out and code example links

* Optimised images with calibre/image-actions

* add placeholders for new diagrams

* 1ps becomes 1pp

* add images

* add missing image

* Optimised images with calibre/image-actions

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 81cc853)
strickvl added a commit that referenced this pull request May 8, 2024
* Add reranking section to LLMOps guide (#2679)

* add docs on rerankers

* update toc

* add try it out and code example links

* Optimised images with calibre/image-actions

* add placeholders for new diagrams

* 1ps becomes 1pp

* add images

* add missing image

* Optimised images with calibre/image-actions

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
(cherry picked from commit 81cc853)

* Updated Readme (#2675)

* Initial draft

* First two gifs

* Added fourth gif

* Slowed down gifs, resized headers, reduced top block

* Moved Header

* Applied suggestions

* Added Colab badge

(cherry picked from commit 5a4c59c)

---------

Co-authored-by: Alexej Penner <thealexejpenner@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants