Update README.md

README.md

@@ -1,3 +1,51 @@
----
-license: bsd-3-clause-clear
----
+---
+license: bsd-3-clause
+configs:
+- config_name: openai
+  data_files:
+  - split: text-embedding-3-large
+    path: openai/text-embedding-3-large/*.parquet
+- config_name: snowflake
+  data_files:
+  - split: snowflake-arctic-embed
+    path: ollama/snowflake_arctic/*.parquet
+size_categories:
+- 100K<n<1M
+---
+##  Loading dataset with vector embeddings
+
+You can load the dataset like this:
+
+```python
+from datasets import load_dataset
+dataset = load_dataset("weaviate/wiki-sample", "openai", split="text-embedding-3-large", streaming=True)
+# dataset = load_dataset("weaviate/wiki-sample", "snowflake", split="snowflake-arctic-embed", streaming=True)
+
+for item in dataset:
+    print(item["text"])
+    print(item["title"])
+    print(item["url"])
+    print(item["wiki_id"])
+    print(item["vector"])
+    print()
+```
+
+## Supported Datasets
+
+### OpenAI
+
+**text-embedding-3-large** - 3072d vectors - generated with OpenAI
+
+```python
+from datasets import load_dataset
+dataset = load_dataset("weaviate/wiki-sample", "openai", split="text-embedding-3-large", streaming=True)
+```
+
+### Snowflake
+
+**snowflake-arctic-embed** - 1024 vectors - generated with Ollama
+
+```python
+from datasets import load_dataset
+dataset = load_dataset("weaviate/wiki-sample", "snowflake", split="snowflake-arctic-embed", streaming=True)
+```