rameshbasina commited on
Commit
a9cede8
·
verified ·
1 Parent(s): 3ebf13c

Update dataset card

Browse files
Files changed (1) hide show
  1. README.md +382 -22
README.md CHANGED
@@ -1,24 +1,384 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: id
5
- dtype: string
6
- - name: embedding
7
- list: float32
8
- length: 384
9
- - name: document
10
- dtype: string
11
- - name: metadata
12
- dtype: string
13
- splits:
14
- - name: train
15
- num_bytes: 15595559
16
- num_examples: 4838
17
- download_size: 10463189
18
- dataset_size: 15595559
19
- configs:
20
- - config_name: default
21
- data_files:
22
- - split: train
23
- path: data/train-*
 
 
 
 
 
 
 
24
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ task_categories:
4
+ - feature-extraction
5
+ - text-retrieval
6
+ - question-answering
7
+ task_ids:
8
+ - semantic-similarity-scoring
9
+ - document-retrieval
10
+ - open-domain-qa
11
+ language:
12
+ - en
13
+ tags:
14
+ - embeddings
15
+ - vector-database
16
+ - rag
17
+ - retrieval-augmented-generation
18
+ - semantic-search
19
+ - knowledge-base
20
+ - accounting
21
+ size_categories:
22
+ - 1K<n<10K
23
+ annotations_creators:
24
+ - machine-generated
25
+ language_creators:
26
+ - found
27
+ multilinguality: monolingual
28
+ pretty_name: Accounting Vectorstore Dataset
29
+ source_datasets:
30
+ - original
31
  ---
32
+
33
+ # Vectorstore Dataset: Accounting
34
+
35
+ ## Overview
36
+
37
+ This dataset contains pre-computed vector embeddings for the **accounting** domain, ready for use in Retrieval-Augmented Generation (RAG) applications, semantic search, and knowledge base systems. The embeddings are generated from high-quality source documents using state-of-the-art sentence transformers, making it easy to build production-ready RAG applications without the computational overhead of embedding generation.
38
+
39
+ ## Key Features
40
+
41
+ - ✅ **Pre-computed embeddings**: Ready-to-use vector embeddings, saving computation time
42
+ - ✅ **Production-ready**: Optimized for real-world RAG applications
43
+ - ✅ **Comprehensive metadata**: Includes source file information, page numbers, and document hashes
44
+ - ✅ **LangChain compatible**: Works seamlessly with LangChain and ChromaDB
45
+ - ✅ **Search-optimized**: Designed for fast semantic similarity search
46
+
47
+ ## What's Included
48
+
49
+ This dataset contains **4,838** text chunks from **2** source documents, each pre-embedded using the `sentence-transformers/all-MiniLM-L6-v2` model. Each chunk includes:
50
+ - **Text content**: The original document text
51
+ - **Embedding vector**: 384-dimensional float32 vector
52
+ - **Rich metadata**: Source file, page numbers, document hash, and more
53
+
54
+ ## Dataset Details
55
+
56
+ ### Dataset Summary
57
+
58
+ - **Domain**: `accounting`
59
+ - **Total Chunks**: 4,838
60
+ - **Total Documents**: 2
61
+ - **Database Size**: 52.77 MB (8 files)
62
+ - **Embedding Model**: `sentence-transformers/all-MiniLM-L6-v2`
63
+ - **Chunk Size**: 1000
64
+ - **Chunk Overlap**: 200
65
+
66
+ ### Dataset Structure
67
+
68
+ The dataset contains the following columns:
69
+
70
+ - **id**: Unique identifier for each chunk
71
+ - **embedding**: Vector embedding (numpy array, dtype=float32)
72
+ - **document**: Original text content of the chunk
73
+ - **metadata**: JSON string containing metadata (file_name, file_hash, page_number, etc.)
74
+
75
+ ### Embedding Model
76
+
77
+ This dataset uses embeddings from: `sentence-transformers/all-MiniLM-L6-v2`
78
+
79
+ ## Usage
80
+
81
+ ### Loading the Dataset
82
+
83
+ ```python
84
+ from datasets import load_dataset
85
+
86
+ # Load the dataset
87
+ dataset = load_dataset("meetara-lab/vectorstore-accounting")
88
+
89
+ # Access the data
90
+ print(dataset["train"][0])
91
+ # Output:
92
+ # {
93
+ # 'id': '...',
94
+ # 'embedding': array([...], dtype=float32),
95
+ # 'document': '...',
96
+ # 'metadata': '{"file_name": "...", "page": 1, ...}'
97
+ # }
98
+ ```
99
+
100
+ ### Loading Back into ChromaDB
101
+
102
+ ```python
103
+ from langchain_chroma import Chroma
104
+ from langchain_huggingface import HuggingFaceEmbeddings
105
+ from datasets import load_dataset
106
+ import json
107
+
108
+ # Load dataset
109
+ dataset = load_dataset("meetara-lab/vectorstore-accounting")["train"]
110
+
111
+ # Initialize ChromaDB
112
+ embeddings = HuggingFaceEmbeddings(model_name="sentence-transformers/all-MiniLM-L6-v2")
113
+ vectorstore = Chroma(
114
+ persist_directory="./chroma_accounting",
115
+ embedding_function=embeddings
116
+ )
117
+
118
+ # Add documents to ChromaDB
119
+ documents = []
120
+ metadatas = []
121
+ ids = []
122
+ embeddings_list = []
123
+
124
+ for item in dataset:
125
+ ids.append(item["id"])
126
+ embeddings_list.append(item["embedding"].tolist())
127
+ documents.append(item["document"])
128
+ metadatas.append(json.loads(item["metadata"]))
129
+
130
+ # Note: You'll need to use ChromaDB's Python client directly for custom embeddings
131
+ import chromadb
132
+ client = chromadb.PersistentClient(path="./chroma_accounting")
133
+ collection = client.create_collection(name="accounting")
134
+
135
+ collection.add(
136
+ ids=ids,
137
+ embeddings=embeddings_list,
138
+ documents=documents,
139
+ metadatas=metadatas
140
+ )
141
+ ```
142
+
143
+ ### Using with LangChain
144
+
145
+ ```python
146
+ from langchain_chroma import Chroma
147
+ from langchain_huggingface import HuggingFaceEmbeddings
148
+
149
+ # Initialize retriever
150
+ embeddings = HuggingFaceEmbeddings(model_name="sentence-transformers/all-MiniLM-L6-v2")
151
+ vectorstore = Chroma(
152
+ persist_directory="./chroma_accounting",
153
+ embedding_function=embeddings
154
+ )
155
+
156
+ # Load from HF Hub first (see above), then use with LangChain
157
+ retriever = vectorstore.as_retriever()
158
+ results = retriever.invoke("your query here")
159
+ ```
160
+
161
+ ### Domain-Specific Usage Examples
162
+
163
+ This vectorstore is optimized for **Accounting** domain queries. Here are practical examples:
164
+
165
+ #### Example Queries
166
+
167
+ ```python
168
+ from langchain_chroma import Chroma
169
+ from langchain_huggingface import HuggingFaceEmbeddings
170
+
171
+ # Load vectorstore (see "Loading Back into ChromaDB" above)
172
+ embeddings = HuggingFaceEmbeddings(model_name="sentence-transformers/all-MiniLM-L6-v2")
173
+ vectorstore = Chroma(
174
+ persist_directory="./chroma_accounting",
175
+ embedding_function=embeddings
176
+ )
177
+ retriever = vectorstore.as_retriever(search_kwargs={"k": 3})
178
+
179
+ # Example queries for accounting domain:
180
+ example_queries = [
181
+ "What information is available about accounting?",
182
+ "How to get started with accounting?",
183
+ "Best practices for accounting",
184
+ "Common questions about accounting",
185
+ "Resources for accounting"
186
+ ]
187
+
188
+ # Run a query
189
+ query = "What information is available about accounting?"
190
+ results = retriever.invoke(query)
191
+
192
+ # Display results
193
+ for i, doc in enumerate(results, 1):
194
+ print(f"\nResult {i}:")
195
+ print(f" Source: {doc.metadata.get('file_name', 'Unknown')}")
196
+ print(f" Page: {doc.metadata.get('page', 'N/A')}")
197
+ print(f" Content: {doc.page_content[:200]}...")
198
+ ```
199
+
200
+ #### Common Use Cases
201
+
202
+ This dataset is useful for:
203
+ - **Information retrieval**
204
+ - **Educational content lookup**
205
+ - **Best practices reference**
206
+ - **Resource discovery**
207
+ - **Domain-specific queries**
208
+
209
+ #### Real-World Example
210
+
211
+ ```python
212
+ # Complete example: Query and use results
213
+ from langchain_chroma import Chroma
214
+ from langchain_huggingface import HuggingFaceEmbeddings
215
+
216
+ # 1. Initialize (after loading from HF Hub)
217
+ embeddings = HuggingFaceEmbeddings(model_name="sentence-transformers/all-MiniLM-L6-v2")
218
+ vectorstore = Chroma(
219
+ persist_directory="./chroma_accounting",
220
+ embedding_function=embeddings
221
+ )
222
+
223
+ # 2. Create retriever with relevance filtering
224
+ retriever = vectorstore.as_retriever(
225
+ search_type="similarity",
226
+ search_kwargs={
227
+ "k": 5, # Get top 5 most relevant results
228
+ "score_threshold": 0.7 # Minimum similarity score
229
+ }
230
+ )
231
+
232
+ # 3. Query the vectorstore
233
+ query = "How to get started with accounting?"
234
+ docs = retriever.invoke(query)
235
+
236
+ # 4. Process results
237
+ for doc in docs:
238
+ metadata = doc.metadata
239
+ print(f"📄 File: {metadata.get('file_name', 'Unknown')}")
240
+ print(f"📃 Page: {metadata.get('page', 'N/A')}")
241
+ print(f"📝 Content: {doc.page_content[:300]}...\n")
242
+ ```
243
+
244
+ ## Dataset Statistics
245
+
246
+ ### Content Statistics
247
+ - **Total Chunks**: 4,838
248
+ - **Total Documents**: 2
249
+ - **Average Chunks per Document**: 2419.0
250
+ - **Database Size**: 52.77 MB (8 files)
251
+
252
+ ### Technical Specifications
253
+ - **Embedding Model**: `sentence-transformers/all-MiniLM-L6-v2` (384 dimensions)
254
+ - **Chunk Size**: 1000 characters
255
+ - **Chunk Overlap**: 200 characters
256
+ - **Format**: Parquet/Arrow (optimized for fast loading)
257
+
258
+ ## Performance Considerations
259
+
260
+ ### Loading Time
261
+ - Full dataset loads in ~5-15 seconds on average hardware
262
+ - Memory usage: ~7.1 MB for embeddings alone
263
+ - Recommended RAM: 2GB+ for full dataset operations
264
+
265
+ ### Search Performance
266
+ - Typical query time: <100ms for similarity search
267
+ - Optimized for retrieval of top-k results (k=5-10)
268
+ - Works best with vector databases like ChromaDB, Pinecone, or Weaviate
269
+
270
+ ## Citation
271
+
272
+ If you use this dataset, please cite:
273
+
274
+ ```bibtex
275
+ @dataset{meetara_vectorstore_accounting,
276
+ title={meeTARA Vectorstore: Accounting},
277
+ author={meeTARA Lab},
278
+ year={2024},
279
+ url={https://huggingface.co/datasets/meetara-lab/vectorstore-accounting}
280
+ }
281
+ ```
282
+
283
+ ## Limitations and Considerations
284
+
285
+ - **Language**: This dataset is monolingual (English only)
286
+ - **Domain specificity**: Optimized for accounting domain queries
287
+ - **Embedding model**: Uses `sentence-transformers/all-MiniLM-L6-v2` - ensure compatibility if switching models
288
+ - **Update frequency**: Dataset reflects state at time of publication; source documents may have been updated
289
+
290
+ ## Alternatives and Related Datasets
291
+
292
+ Looking for other domains? Check out the complete meeTARA Vectorstore collection:
293
+
294
+ ### Healthcare Domain
295
+ - 🏥 `meetara-lab/vectorstore-general_health` - General Health (35,556 chunks)
296
+ - 💊 `meetara-lab/vectorstore-healthcare` - Healthcare (Available)
297
+ - 🧠 `meetara-lab/vectorstore-mental_health` - Mental Health (407 chunks)
298
+ - 💊 `meetara-lab/vectorstore-nutrition` - Nutrition (1,165 chunks)
299
+ - 💊 `meetara-lab/vectorstore-senior_health` - Senior Health (410 chunks)
300
+ - 👩 `meetara-lab/vectorstore-women_health` - Women Health (318 chunks)
301
+
302
+ ### Education Domain
303
+ - 📚 `meetara-lab/vectorstore-academic_tutoring` - Academic Tutoring (64,845 chunks)
304
+ - 📚 `meetara-lab/vectorstore-education` - Education (Available)
305
+
306
+ ### Other Domains
307
+ - 📁 `meetara-lab/vectorstore-ai_ml` - Ai Ml (131 chunks)
308
+ - 📁 `meetara-lab/vectorstore-bipolar_disorder` - Bipolar Disorder (65 chunks)
309
+ - 📁 `meetara-lab/vectorstore-chronic_conditions` - Chronic Conditions (1,882 chunks)
310
+ - 📁 `meetara-lab/vectorstore-economics` - Economics (2,195 chunks)
311
+ - 📁 `meetara-lab/vectorstore-emergency_care` - Emergency Care (52 chunks)
312
+ - 📁 `meetara-lab/vectorstore-medication_management` - Medication Management (161 chunks)
313
+ - 📁 `meetara-lab/vectorstore-parenting` - Parenting (460 chunks)
314
+ - 📁 `meetara-lab/vectorstore-preventive_care` - Preventive Care (253 chunks)
315
+ - 📁 `meetara-lab/vectorstore-programming` - Programming (171 chunks)
316
+ - 📁 `meetara-lab/vectorstore-publish` - Publish (Available)
317
+ - 📁 `meetara-lab/vectorstore-software_development` - Software Development (82 chunks)
318
+ - 📁 `meetara-lab/vectorstore-space_technology` - Space Technology (15 chunks)
319
+ - 📁 `meetara-lab/vectorstore-sports_recreation` - Sports Recreation (Available)
320
+ - 📁 `meetara-lab/vectorstore-stress_management` - Stress Management (26 chunks)
321
+ - 📁 `meetara-lab/vectorstore-tech_support` - Tech Support (2,920 chunks)
322
+
323
+ **🔗 View all meeTARA datasets**: [https://huggingface.co/meetara-lab](https://huggingface.co/meetara-lab)
324
+
325
+ **💡 Tip**: Combine multiple domain datasets for comprehensive multi-domain RAG applications!
326
+
327
+ ## Maintenance and Updates
328
+
329
+ This dataset is maintained by the meeTARA Lab team.
330
+
331
+ - **Last Updated**: 2026-02-07
332
+ - **Version**: 1.0
333
+ - **Update Policy**: Datasets are updated periodically as source documents are added or improved
334
+ - **Notifications**: Follow the repository to receive updates when new versions are published
335
+
336
+ For updates, bug reports, or feature requests, please visit our GitHub repository.
337
+
338
+ ## License
339
+
340
+ This dataset is released under the **Apache 2.0 License**. This means you are free to:
341
+ - Use the dataset commercially and non-commercially
342
+ - Modify and create derivative works
343
+ - Distribute the dataset and modifications
344
+
345
+ Please see the full license text for complete terms.
346
+
347
+ ## Citation
348
+
349
+ If you use this dataset in your research or applications, please cite it as:
350
+
351
+ ```bibtex
352
+ @dataset{meetara_vectorstore_accounting,
353
+ title={meeTARA Vectorstore: Accounting},
354
+ author={meeTARA Lab},
355
+ year={2024},
356
+ url={https://huggingface.co/datasets/meetara-lab/vectorstore-accounting},
357
+ license={apache-2.0},
358
+ task={feature-extraction, text-retrieval, rag}
359
+ }
360
+ ```
361
+
362
+ ## Contact and Support
363
+
364
+ - **GitHub**: [meetara-lab/meetara-core](https://github.com/meetara-lab/meetara-core)
365
+ - **Hugging Face Profile**: [@meetara-lab](https://huggingface.co/meetara-lab)
366
+ - **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/meetara-lab/meetara-core/issues)
367
+ - **Documentation**: Visit our repository for detailed documentation
368
+ - **Dataset Requests**: Want a new domain? [Open an issue](https://github.com/meetara-lab/meetara-core/issues) to request it!
369
+
370
+ ## Contributing
371
+
372
+ We welcome contributions! If you'd like to:
373
+ - 🐛 Report bugs
374
+ - 💡 Suggest new domains
375
+ - 📝 Improve documentation
376
+ - 🔧 Contribute code
377
+
378
+ Please visit our [GitHub repository](https://github.com/meetara-lab/meetara-core).
379
+
380
+ ---
381
+
382
+ **Made with ❤️ by the meeTARA Lab team**
383
+
384
+ **Part of the meeTARA Vectorstore Collection** - Empowering RAG applications with high-quality domain-specific embeddings.