blackwingedking commited on
Commit
c33c3ac
·
1 Parent(s): a31aeef

update README.md with sample code block

Browse files
Files changed (1) hide show
  1. README.md +10 -14
README.md CHANGED
@@ -15,23 +15,27 @@ tags:
15
 
16
  The **DevRev Search Dataset** contains transformed and anonymized user queries on DevRev's public articles, paired with relevant article chunks that answer them. It is designed to benchmark enterprise search and reranking systems. The dataset also includes test queries along with the underlying article chunks used for retrieval.
17
 
18
- ---
19
-
20
  ## Dataset Details
21
 
22
  - **Curated by:** Research@DevRev
23
  - **Language:** English
24
  - **Intended Use:** Evaluation of search, retrieval, and reranking models in enterprise support contexts
25
 
26
- ---
27
-
28
  ## Dataset Structure
29
 
30
  - **`annotated_queries.parquet`** — Queries paired with annotated (golden) article chunks
31
- - **`knowledge_base.parquet`** — Article chunks created from DevRevs customer-facing support documentation
32
  - **`test_queries.parquet`** — Held-out queries used for evaluation
33
 
34
- ---
 
 
 
 
 
 
 
 
35
 
36
  ## Dataset Creation
37
 
@@ -43,21 +47,15 @@ There is a lack of publicly available datasets representing enterprise support s
43
  - **Queries:** Transformed and anonymized versions of real user queries on DevRev's public articles.
44
  - **Knowledge Base Articles:** Segmented (chunked) excerpts from DevRev’s customer-facing support documentation.
45
 
46
- ---
47
-
48
  ## Annotations
49
 
50
  - **Annotation Process:** An automated proprietary pipeline identifies the most relevant article chunks for each query.
51
  - **Annotators:** Fully automated system; no human annotators were used.
52
  - **Validation:** Internal validation was conducted by selecting a representative sample of the automatically generated annotations, which were then manually reviewed by human evaluators to verify their correctness and ensure they meet the desired quality standards.
53
 
54
- ---
55
-
56
  ## Personal and Sensitive Information
57
  All user queries were anonymized and stripped of any identifying or sensitive data. No personal information is included.
58
 
59
- ---
60
-
61
  ## Uses
62
 
63
  - **Primary Use:** Training and evaluation of enterprise search, retrieval, and reranking models.
@@ -65,8 +63,6 @@ All user queries were anonymized and stripped of any identifying or sensitive da
65
  - [Query-to-document retrieval](https://huggingface.co/tasks/text-ranking)
66
  - Reranking evaluation
67
 
68
- ---
69
-
70
  ## Product Impact
71
  This dataset played a key role in honing Computer by DevRev. Learn more about Computer here: [Computer by DevRev | Your New Conversational AI Teammate](https://devrev.ai/meet-computer)
72
 
 
15
 
16
  The **DevRev Search Dataset** contains transformed and anonymized user queries on DevRev's public articles, paired with relevant article chunks that answer them. It is designed to benchmark enterprise search and reranking systems. The dataset also includes test queries along with the underlying article chunks used for retrieval.
17
 
 
 
18
  ## Dataset Details
19
 
20
  - **Curated by:** Research@DevRev
21
  - **Language:** English
22
  - **Intended Use:** Evaluation of search, retrieval, and reranking models in enterprise support contexts
23
 
 
 
24
  ## Dataset Structure
25
 
26
  - **`annotated_queries.parquet`** — Queries paired with annotated (golden) article chunks
27
+ - **`knowledge_base.parquet`** — Article chunks created from DevRev's customer-facing support documentation
28
  - **`test_queries.parquet`** — Held-out queries used for evaluation
29
 
30
+ ## Quick Start
31
+
32
+ ```python
33
+ from datasets import load_dataset
34
+
35
+ annotated_queries = load_dataset("devrev/search", data_files="annotated_queries.parquet", split="train")
36
+ knowledge_base = load_dataset("devrev/search", data_files="knowledge_base.parquet", split="train")
37
+ test_queries = load_dataset("devrev/search", data_files="test_queries.parquet", split="train")
38
+ ```
39
 
40
  ## Dataset Creation
41
 
 
47
  - **Queries:** Transformed and anonymized versions of real user queries on DevRev's public articles.
48
  - **Knowledge Base Articles:** Segmented (chunked) excerpts from DevRev’s customer-facing support documentation.
49
 
 
 
50
  ## Annotations
51
 
52
  - **Annotation Process:** An automated proprietary pipeline identifies the most relevant article chunks for each query.
53
  - **Annotators:** Fully automated system; no human annotators were used.
54
  - **Validation:** Internal validation was conducted by selecting a representative sample of the automatically generated annotations, which were then manually reviewed by human evaluators to verify their correctness and ensure they meet the desired quality standards.
55
 
 
 
56
  ## Personal and Sensitive Information
57
  All user queries were anonymized and stripped of any identifying or sensitive data. No personal information is included.
58
 
 
 
59
  ## Uses
60
 
61
  - **Primary Use:** Training and evaluation of enterprise search, retrieval, and reranking models.
 
63
  - [Query-to-document retrieval](https://huggingface.co/tasks/text-ranking)
64
  - Reranking evaluation
65
 
 
 
66
  ## Product Impact
67
  This dataset played a key role in honing Computer by DevRev. Learn more about Computer here: [Computer by DevRev | Your New Conversational AI Teammate](https://devrev.ai/meet-computer)
68