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

Feature/fix providers page rebased #267

Merged
merged 7 commits into from
Apr 3, 2024

Conversation

emrgnt-cmplxty
Copy link
Contributor

@emrgnt-cmplxty emrgnt-cmplxty commented Apr 3, 2024

Ellipsis 🚀 This PR description was created by Ellipsis for commit 1d197f8.

Summary:

This PR enhances the R2R library documentation by refining the 'Getting Started' guide and adding detailed guides for configuring and using various providers.

Key points:

  • Updated /docs/pages/getting-started/configure-your-pipeline.mdx and /docs/pages/getting-started/customize-your-pipeline.mdx to improve the structure and clarity.
  • Added new files under /docs/pages/providers/ to provide detailed guides for configuring and using various providers (embeddings, evaluations, language models, and vector databases).
  • Created a new _meta.json file under /docs/pages/providers/ to define the metadata for the providers section.

Generated with ❤️ by ellipsis.dev

@emrgnt-cmplxty emrgnt-cmplxty marked this pull request as ready for review April 3, 2024 17:21
Copy link

vercel bot commented Apr 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
r2r-docs 🔄 Building (Inspect) Visit Preview Apr 3, 2024 5:21pm

@emrgnt-cmplxty emrgnt-cmplxty merged commit 9c5294c into main Apr 3, 2024
1 of 2 checks passed
@emrgnt-cmplxty emrgnt-cmplxty deleted the feature/fix-providers-page-rebased branch April 3, 2024 17:23
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested.

  • Reviewed the entire pull request up to 1d197f8
  • Looked at 384 lines of code in 7 files
  • Took 1 minute and 47 seconds to review
More info
  • Skipped 1 files when reviewing.
  • Skipped posting 0 additional comments because they didn't meet confidence threshold of 50%.

Workflow ID: wflow_1P4zSN7GbEc349dG


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. We'll respond in a few minutes. Learn more here.


R2R supports DeepEval and PareaAI as evaluation providers. These providers allow you to evaluate the performance and quality of your RAG pipeline at regular intervals.
- `provider`: Specifies the evaluation provider to use (`deepeval` or `pareaai`).
- `frequency`: Determines how often the pipeline should be evaluated. It represents the fraction of queries that should trigger an evaluation. For example, a frequency of `0.1` means that approximately 10% of the queries will be evaluated.

Here's the updated "Evaluation Provider" section:

Copy link
Contributor

Choose a reason for hiding this comment

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

The 'Evaluation Provider' section is repeated. Please remove the duplicate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant