Upload README.md with huggingface_hub

README.md

@@ -1,94 +1,41 @@
----
-pretty_name: Permutation Groups Benchmark
-tags:
-  - mathematics
-  - group-theory
-  - permutations
-  - sequence-to-sequence
-  - benchmark
-  - generated
-task_categories:
-  - text-generation
-  - sequence-modeling
-licenses:
-  - mit
-configs:
-  - config_name: s3_data
-    data_files:
-      train: data/s3_data/train/data-*.arrow
-      test: data/s3_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Symmetric Group S3.
-  - config_name: s4_data
-    - config_name: s4_data
-    data_files:
-      train: data/s4_data/train/data-*.arrow
-      test: data/s4_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Symmetric Group S4.
-  - config_name: s5_data
-    - config_name: s5_data
-    data_files:
-      train: data/s5_data/train/data-*.arrow
-      test: data/s5_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Symmetric Group S5.
-  - config_name: s6_data
-    data_files:
-      train: data/s6_data/train/data-*.arrow
-      test: data/s6_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Symmetric Group S6.
-  - config_name: s7_data
-    data_files:
-      train: data/s7_data/train/data-*.arrow
-      test: data/s7_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Symmetric Group S7.
-  - config_name: a5_data
-    data_files:
-      train: data/a5_data/train/data-*.arrow
-      test: data/a5_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Alternating Group A5.
-  - config_name: a6_data
-    data_files:
-      train: data/a6_data/train/data-*.arrow
-      test: data/a6_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Alternating Group A6.
-  - config_name: a7_data
-    data_files:
-      train: data/a7_data/train/data-*.arrow
-      test: data/a7_data/test/data-*.arrow
-    description: Permutation Composition Dataset for the Alternating Group A7.
---- 
+# Permutation Groups Datasets
 
-# Permutation Groups Benchmark Dataset
+This repository contains permutation composition datasets for various symmetric and alternating groups.
 
-This repository contains a collection of permutation composition datasets for various symmetric and alternating groups. These datasets are designed for benchmarking sequence-to-sequence models on group theory tasks.
+## Usage
 
-## Dataset Configurations
-
-Each group (e.g., S3, A5) is available as a separate configuration within this dataset. You can load a specific configuration using the `name` argument in `load_dataset`:
+You can load individual datasets or all datasets combined:
 
 ```python
 from datasets import load_dataset
 
-# Load the S3 dataset
-s3_dataset = load_dataset("BeeGass/permutation-groups", name="s3_data")
-
-# Load the A5 dataset
-a5_dataset = load_dataset("BeeGass/permutation-groups", name="a5_data")
+# Load a specific dataset
+s3_dataset = load_dataset("BeeGass/permutation-groups", name="s3_data", trust_remote_code=True)
+s7_dataset = load_dataset("BeeGass/permutation-groups", name="s7_data", trust_remote_code=True)
+a7_dataset = load_dataset("BeeGass/permutation-groups", name="a7_data", trust_remote_code=True)
 
-# Load all datasets (as a DatasetDict of DatasetDicts)
-all_datasets = load_dataset("BeeGass/permutation-groups")
+# Load all datasets combined
+all_datasets = load_dataset("BeeGass/permutation-groups", name="all", trust_remote_code=True)
 ```
 
-## Data Structure
-
-Each dataset configuration contains `train` and `test` splits. Each sample in the dataset has the following features:
+## Available Configurations
 
-- `input_sequence`: A space-separated string of integer IDs representing the sequence of permutations to be composed.
-- `target`: An integer ID representing the composition of the `input_sequence` permutations.
+- `s3_data`: Symmetric Group S3
+- `s4_data`: Symmetric Group S4
+- `s5_data`: Symmetric Group S5
+- `s6_data`: Symmetric Group S6
+- `s7_data`: Symmetric Group S7
+- `a5_data`: Alternating Group A5
+- `a6_data`: Alternating Group A6
+- `a7_data`: Alternating Group A7
+- `all`: All datasets combined
 
-## Permutation Mapping
+## Dataset Structure
 
-For each configuration, the mapping from integer IDs to their corresponding permutation array forms is provided in a `metadata.json` file located within the respective subfolder (e.g., `s3_data/metadata.json`). This file is crucial for interpreting the `input_sequence` and `target` IDs.
+Each dataset contains:
+- `input_sequence`: Space-separated sequence of permutation IDs
+- `target`: The ID of the composed permutation
 
 ## License
 
-This dataset is licensed under the MIT License.
+MIT