Update README.md
Browse files
README.md
CHANGED
|
@@ -4,7 +4,7 @@ dataset_info:
|
|
| 4 |
- name: article
|
| 5 |
dtype: string
|
| 6 |
- name: embedding
|
| 7 |
-
sequence:
|
| 8 |
splits:
|
| 9 |
- name: train
|
| 10 |
num_bytes: 6526015558
|
|
@@ -16,4 +16,100 @@ configs:
|
|
| 16 |
data_files:
|
| 17 |
- split: train
|
| 18 |
path: data/train-*
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
- name: article
|
| 5 |
dtype: string
|
| 6 |
- name: embedding
|
| 7 |
+
sequence: float32
|
| 8 |
splits:
|
| 9 |
- name: train
|
| 10 |
num_bytes: 6526015558
|
|
|
|
| 16 |
data_files:
|
| 17 |
- split: train
|
| 18 |
path: data/train-*
|
| 19 |
+
license: other
|
| 20 |
+
task_categories:
|
| 21 |
+
- sentence-similarity
|
| 22 |
+
language:
|
| 23 |
+
- en
|
| 24 |
+
pretty_name: CCNEWS with Embeddings (dim=1024)
|
| 25 |
+
tags:
|
| 26 |
+
- embeddings
|
| 27 |
+
- sentence-transformers
|
| 28 |
+
- similarity-search
|
| 29 |
+
- parquet
|
| 30 |
+
- ccnews
|
| 31 |
---
|
| 32 |
+
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
# Dataset Card for `ccnews_all-roberta-large-v1_dim1024`
|
| 36 |
+
|
| 37 |
+
This dataset contains English news articles from the [CCNEWS dataset](https://huggingface.co/datasets/sentence-transformers/ccnews) along with their corresponding 1024-dimensional embeddings, precomputed using the `sentence-transformers/all-roberta-large-v1` model.
|
| 38 |
+
|
| 39 |
+
|
| 40 |
+
## Dataset Details
|
| 41 |
+
|
| 42 |
+
### Dataset Description
|
| 43 |
+
|
| 44 |
+
Each entry in this dataset is stored in Apache Parquet format, split into multiple files for scalability. Each record contains two fields:
|
| 45 |
+
|
| 46 |
+
- `'article'`: The original news article text.
|
| 47 |
+
- `'embedding'`: A 1024-dimensional list representing the output of the `sentence-transformers/all-roberta-large-v1` encoder.
|
| 48 |
+
|
| 49 |
+
- **Curated by:** Scarlett Magdaleno
|
| 50 |
+
- **Language(s) (NLP):** English
|
| 51 |
+
- **License:** Other (the dataset is a derivative of the CCNEWS dataset, which may carry its own license)
|
| 52 |
+
|
| 53 |
+
### Dataset Sources
|
| 54 |
+
|
| 55 |
+
- **Base Text Dataset:** [sentence-transformers/ccnews](https://huggingface.co/datasets/sentence-transformers/ccnews)
|
| 56 |
+
- **Embedding Model:** [sentence-transformers/all-roberta-large-v1](https://huggingface.co/sentence-transformers/all-roberta-large-v1)
|
| 57 |
+
|
| 58 |
+
## Dataset Creation
|
| 59 |
+
|
| 60 |
+
### Curation Rationale
|
| 61 |
+
|
| 62 |
+
The dataset was created to enable fast and reproducible similarity search experiments, as well as to provide a resource where the relationship between the raw text and its embedding is explicitly retained.
|
| 63 |
+
|
| 64 |
+
### Source Data
|
| 65 |
+
|
| 66 |
+
#### Data Collection and Processing
|
| 67 |
+
|
| 68 |
+
- Texts were taken from the CCNEWS dataset available on Hugging Face.
|
| 69 |
+
- Each article was passed through the encoder `all-roberta-large-v1` from the `sentence-transformers` library.
|
| 70 |
+
- The resulting embeddings were stored along with the article in Parquet format for efficient disk usage and interoperability.
|
| 71 |
+
|
| 72 |
+
#### Who are the source data producers?
|
| 73 |
+
|
| 74 |
+
- The original texts come from English-language news websites.
|
| 75 |
+
- The embeddings were generated and curated by Scarlett Magdaleno.
|
| 76 |
+
|
| 77 |
+
- **Repository:** https://huggingface.co/datasets/ScarlettMagdaleno/ccnews_all-roberta-large-v1_dim1024
|
| 78 |
+
|
| 79 |
+
## Uses
|
| 80 |
+
|
| 81 |
+
### Direct Use
|
| 82 |
+
|
| 83 |
+
This dataset is suitable for:
|
| 84 |
+
|
| 85 |
+
- Training and evaluating similarity search models.
|
| 86 |
+
- Experiments involving semantic representation of news content.
|
| 87 |
+
- Weakly supervised learning using embeddings as targets or features.
|
| 88 |
+
- Benchmarks for contrastive or clustering approaches.
|
| 89 |
+
|
| 90 |
+
### Out-of-Scope Use
|
| 91 |
+
|
| 92 |
+
- Not suitable for generative modeling tasks (no labels, no dialogues, no instructions).
|
| 93 |
+
- Does not include metadata such as timestamps, URLs, or categories.
|
| 94 |
+
|
| 95 |
+
## Dataset Structure
|
| 96 |
+
|
| 97 |
+
Each Parquet file contains a table with two columns:
|
| 98 |
+
|
| 99 |
+
- `article` (string): The raw article text.
|
| 100 |
+
- `embedding` (list[float]): A list of 1024 float values representing the semantic embedding.
|
| 101 |
+
|
| 102 |
+
### Format
|
| 103 |
+
|
| 104 |
+
- Storage format: Apache Parquet.
|
| 105 |
+
- Total records: same as CCNEWS — approximately 614,664 articles.
|
| 106 |
+
- Split: the dataset is divided into multiple parquet files for better loading performance.
|
| 107 |
+
|
| 108 |
+
### Example Record
|
| 109 |
+
|
| 110 |
+
```json
|
| 111 |
+
{
|
| 112 |
+
"article": "U.S. President signs new environmental policy...",
|
| 113 |
+
"embedding": [0.023, -0.117, ..., 0.098] # 1024 values
|
| 114 |
+
}
|
| 115 |
+
|