Spaces:
Sleeping
Sleeping
Upload LiveRAG_README (5).md
Browse files- LiveRAG_README (5).md +62 -0
LiveRAG_README (5).md
ADDED
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# π LiveRAG Challenge Operational Instructions
|
2 |
+
---
|
3 |
+
## π£ LiveRAG Challenge Step-by-Step Guide
|
4 |
+
|
5 |
+
1. Accessing DataMorgana and Falcon3-10B-Instruct via AI71-Platform\
|
6 |
+
1.1 Register to [AI71-Platform](https://platform.ai71.ai/register) and send the email address used for registration to sigir2025-liverag-tech@tii.ae
|
7 |
+
1.2 After you're notified that you have clearance, login to your [AI71-Platform account](https://platform.ai71.ai)\
|
8 |
+
1.2.1 Access the DataMorgana [Sandbox](https://platform.ai71.ai/playground) and [try it](Operational_Instructions/DM_Sandbox.md) to get your first Q&A\
|
9 |
+
1.2.2 Create your AI71-Platform [API key](https://platform.ai71.ai/api-keys)\
|
10 |
+
1.3 Use your AI71-Platform key for programatic access to DataMorgana bulk requests generation via its [API](Operational_Instructions/DM_API_usage_example.ipynb)\
|
11 |
+
1.4 Use your AI71-Platform key for programatic access to Falcon3-10B-Instruct (see [AI71 documentation](https://platform.ai71.ai/documentation))\
|
12 |
+
**Remark:** Accessing Falcon via the AI71-Platform API is optional and recommended for a quick start. However, for a robust solution, suitable for the live event, it is recommended to set up your own Falcon3-10B-Instruct instance
|
13 |
+
|
14 |
+
3. Using [Pinecone](https://www.pinecone.io/) and [OpenSearch](https://opensearch.org/) pre-built indices of [FineWeb Sample-10BT](https://huggingface.co/datasets/HuggingFaceFW/fineweb/viewer/sample-10BT) and building your own indices\
|
15 |
+
2.1 To use the pre-built indices follow this [sample notebook](Operational_Instructions/Indices_Usage_Examples_for_LiveRAG.ipynb)\
|
16 |
+
2.2 To build your own **OpenSearch** index, create or use your existing AWS account and apply the provided AWS credits to save costs (see [here](Operational_Instructions/AWS_and_Pinecone_Accounts_for_LiveRAG.md))\
|
17 |
+
2.3 To build your own **Pinecone** index, create or use your existing Pinecone account and apply the provided Pinecone credits to save costs (see [here](Operational_Instructions/Pinecone_for_LiveRAG.md))
|
18 |
+
|
19 |
+
4. Building, training, and evaluating your RAG system\
|
20 |
+
3.1 Use your AWS private account or any other platform to build your RAG system using Falcon3-10B-Instruct\
|
21 |
+
3.2 Build your own indices or use the pre-built Pinecone and OpenSearch indices\
|
22 |
+
3.3 Use the DataMorgana [API](Operational_Instructions/DM_API_usage_example.ipynb) to get training Q&A pairs\
|
23 |
+
3.4 Follow the [evaluation guidelines](Operational_Instructions/Evaluation_Guidelines_for_LiveRAG.md) to evaluate your RAG system
|
24 |
+
|
25 |
+
5. You may contact the organizers via:\
|
26 |
+
4.1 sigir2025-liverag-gen@tii.ae - for general issues\
|
27 |
+
4.2 sigir2025-liverag-tech@tii.ae - for technical issues
|
28 |
+
|
29 |
+
6. LiveRAG live event details will be added soon...
|
30 |
+
|
31 |
+
---
|
32 |
+
## π DataMorgana
|
33 |
+
|
34 |
+
- π [**DataMorgana Overview**](Operational_Instructions/DM_Overview.md)
|
35 |
+
- π [**DataMorgana ArXiv Paper**](Operational_Instructions/Generating_Diverse_Q&A_Benchmarks_for_RAG_Evaluation_with_DataMorgana.pdf)
|
36 |
+
- ποΈ [**DataMorgana Sandbox**](Operational_Instructions/DM_Sandbox.md)
|
37 |
+
- π οΈ [**DataMorgana API**](Operational_Instructions/DM_API_usage_example.ipynb)
|
38 |
+
- π€ [**DataMorgana Q&A Examples**](https://docs.google.com/spreadsheets/d/1rWzRiFVRWHUruP5vK4P6PNxgZgpi9OLX5YRi5Kc7k4g/edit?usp=sharing)
|
39 |
+
|
40 |
+
---
|
41 |
+
## AWS and Pinecone Documentation
|
42 |
+
|
43 |
+
- π [**AWS Documentation**](Operational_Instructions/AWS_Documentation_Links.md)
|
44 |
+
- π [**Pinecone Documentation**](Operational_Instructions/Pinecone_Documentation_Links.md)
|
45 |
+
|
46 |
+
---
|
47 |
+
## π Accounts
|
48 |
+
|
49 |
+
- βοΈ [**AWS and Pinecone Accounts**](Operational_Instructions/AWS_and_Pinecone_Accounts_for_LiveRAG.md)
|
50 |
+
|
51 |
+
---
|
52 |
+
|
53 |
+
## π Indices
|
54 |
+
|
55 |
+
- ποΈ [**Using Pinecone**](Operational_Instructions/Pinecone_for_LiveRAG.md)
|
56 |
+
- π [**Indices Usage Examples**](Operational_Instructions/Indices_Usage_Examples_for_LiveRAG.ipynb)
|
57 |
+
|
58 |
+
---
|
59 |
+
|
60 |
+
## π― Evaluation
|
61 |
+
|
62 |
+
- π [**RAG Evaluation Guidelines**](Operational_Instructions/Evaluation_Guidelines_for_LiveRAG.md)
|