Skip to content

Akshay/rag eval #156

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+28 −0
Open

Akshay/rag eval #156

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c74b0b
Adding RAG eval readme
patchy631 Nov 7, 2024
18105d8
modified readme
patchy631 Nov 7, 2024
c3b31b0
modified readme
patchy631 Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions rag-evaluation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Evaluating RAGs!

In this repo we provide a streamlined approach to evaluating Retrieval-Augmented Generation (RAG) systems. It includes tools for assessing response accuracy, relevance, and overall performance, helping you optimize and refine RAG models with ease.

Comment on lines +1 to +4
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Clarify project scope & add usage/installation details

Great high-level pitch, but the README stops short of telling users how to run or integrate the toolkit. Add at minimum:

  • “Quick Start” (pip install / Docker / local setup)
  • “Basic Example” (1-2 commands or code snippet that calls the evaluator)
  • “Requirements” (Python version, GPU/CPU expectations, etc.)

Without these, new users will bounce.

🤖 Prompt for AI Agents 
In rag-evaluation/README.md lines 1 to 4, the README introduces the project but
lacks essential usage and setup information. Add sections for "Quick Start" with
installation instructions (e.g., pip install, Docker, or local setup), "Basic
Example" showing 1-2 commands or a code snippet to run the evaluator, and
"Requirements" specifying Python version and hardware expectations. This will
help new users understand how to install, run, and integrate the toolkit
effectively.

---

## 📬 Stay Updated with Our Newsletter!
Get a FREE Data Science eBook 📖 with 150+ essential lessons in Data Science when you subscribe to our newsletter! Stay in the loop with the latest tutorials, insights, and exclusive resources. [Subscribe now!](https://join.dailydoseofds.com)

[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)

---

## 📢 Contribute to the AI Engineering Hub!
We welcome contributors! Whether you want to add new tutorials, improve existing code, or report issues, your contributions make this community thrive. Here’s how to get involved:
1. **Fork** the repository.
2. Create a new branch for your contribution.
3. Submit a **Pull Request** and describe the improvements.

---

## 📜 License
This repository is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 💬 Connect
For discussions, suggestions, and more, feel free to [create an issue](https://github.com/patchy631/ai-engineering/issues) or reach out directly!

Comment on lines +25 to +27
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Issue link points to another repo

https://github.com/patchy631/ai-engineering/issues redirects users away from this project. Replace with the current repo’s issues URL.

-[create an issue](https://github.com/patchy631/ai-engineering/issues)
+[create an issue](https://github.com/<org-or-user>/rag-evaluation/issues)

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents 
In rag-evaluation/README.md around lines 25 to 27, the issue link points to a
different repository which redirects users away from the current project. Update
the URL in the "create an issue" link to point to the issues page of the current
repository to keep users within the correct project context.

Happy Coding! 🎉