Update README.md

README.md

@@ -1,325 +1,413 @@
----
-license: cc-by-4.0
-dataset_info:
-- config_name: assamese
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5082850536.85
-    num_examples: 41766
-  download_size: 5229826172
-  dataset_size: 5082850536.85
-- config_name: bengali
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 1970326408.576
-    num_examples: 17882
-  download_size: 1916156215
-  dataset_size: 1970326408.576
-- config_name: dogri
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3603495138.825
-    num_examples: 23721
-  download_size: 3568871899
-  dataset_size: 3603495138.825
-- config_name: gujarati
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 16321596906.35
-    num_examples: 137965
-  download_size: 17665902401
-  dataset_size: 16321596906.35
-- config_name: hindi
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 97821772346.85
-    num_examples: 734675
-  download_size: 94834500694
-  dataset_size: 97821772346.85
-- config_name: kannada
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 20069410879.104
-    num_examples: 192208
-  download_size: 21641876571
-  dataset_size: 20069410879.104
-- config_name: konkani
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 1246784105.294
-    num_examples: 12239
-  download_size: 1239977556
-  dataset_size: 1246784105.294
-- config_name: maithili
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 2985296990.293
-    num_examples: 22233
-  download_size: 2895972814
-  dataset_size: 2985296990.293
-- config_name: malayalam
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 17608171088.553
-    num_examples: 224323
-  download_size: 19431260422
-  dataset_size: 17608171088.553
-- config_name: marathi
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 42353055748.775
-    num_examples: 336475
-  download_size: 38603401934
-  dataset_size: 42353055748.775
-- config_name: nepali
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5214995797.048
-    num_examples: 31997
-  download_size: 4990235585
-  dataset_size: 5214995797.048
-- config_name: odia
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 12687640571.75
-    num_examples: 126675
-  download_size: 16473690962
-  dataset_size: 12687640571.75
-- config_name: punjabi
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 3054398341.146
-    num_examples: 21118
-  download_size: 3181612927
-  dataset_size: 3054398341.146
-- config_name: sanskrit
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 2036760741.337
-    num_examples: 14177
-  download_size: 2036474974
-  dataset_size: 2036760741.337
-- config_name: tamil
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 33855148157.352
-    num_examples: 281508
-  download_size: 31654328747
-  dataset_size: 33855148157.352
-- config_name: telugu
-  features:
-  - name: audio_filepath
-    dtype: audio
-  - name: text
-    dtype: string
-  - name: duration
-    dtype: float64
-  - name: lang
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 5722466966.018
-    num_examples: 56082
-  download_size: 5886818756
-  dataset_size: 5722466966.018
-configs:
-- config_name: assamese
-  data_files:
-  - split: train
-    path: assamese/train-*
-- config_name: bengali
-  data_files:
-  - split: train
-    path: bengali/train-*
-- config_name: dogri
-  data_files:
-  - split: train
-    path: dogri/train-*
-- config_name: gujarati
-  data_files:
-  - split: train
-    path: gujarati/train-*
-- config_name: hindi
-  data_files:
-  - split: train
-    path: hindi/train-*
-- config_name: kannada
-  data_files:
-  - split: train
-    path: kannada/train-*
-- config_name: konkani
-  data_files:
-  - split: train
-    path: konkani/train-*
-- config_name: maithili
-  data_files:
-  - split: train
-    path: maithili/train-*
-- config_name: malayalam
-  data_files:
-  - split: train
-    path: malayalam/train-*
-- config_name: marathi
-  data_files:
-  - split: train
-    path: marathi/train-*
-- config_name: nepali
-  data_files:
-  - split: train
-    path: nepali/train-*
-- config_name: odia
-  data_files:
-  - split: train
-    path: odia/train-*
-- config_name: punjabi
-  data_files:
-  - split: train
-    path: punjabi/train-*
-- config_name: sanskrit
-  data_files:
-  - split: train
-    path: sanskrit/train-*
-- config_name: tamil
-  data_files:
-  - split: train
-    path: tamil/train-*
-- config_name: telugu
-  data_files:
-  - split: train
-    path: telugu/train-*
----
+---
+license: cc-by-4.0
+dataset_info:
+- config_name: assamese
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 5082850536.85
+    num_examples: 41766
+  download_size: 5229826172
+  dataset_size: 5082850536.85
+- config_name: bengali
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1970326408.576
+    num_examples: 17882
+  download_size: 1916156215
+  dataset_size: 1970326408.576
+- config_name: dogri
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 3603495138.825
+    num_examples: 23721
+  download_size: 3568871899
+  dataset_size: 3603495138.825
+- config_name: gujarati
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 16321596906.35
+    num_examples: 137965
+  download_size: 17665902401
+  dataset_size: 16321596906.35
+- config_name: hindi
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 97821772346.85
+    num_examples: 734675
+  download_size: 94834500694
+  dataset_size: 97821772346.85
+- config_name: kannada
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 20069410879.104
+    num_examples: 192208
+  download_size: 21641876571
+  dataset_size: 20069410879.104
+- config_name: konkani
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 1246784105.294
+    num_examples: 12239
+  download_size: 1239977556
+  dataset_size: 1246784105.294
+- config_name: maithili
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 2985296990.293
+    num_examples: 22233
+  download_size: 2895972814
+  dataset_size: 2985296990.293
+- config_name: malayalam
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 17608171088.553
+    num_examples: 224323
+  download_size: 19431260422
+  dataset_size: 17608171088.553
+- config_name: marathi
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 42353055748.775
+    num_examples: 336475
+  download_size: 38603401934
+  dataset_size: 42353055748.775
+- config_name: nepali
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 5214995797.048
+    num_examples: 31997
+  download_size: 4990235585
+  dataset_size: 5214995797.048
+- config_name: odia
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 12687640571.75
+    num_examples: 126675
+  download_size: 16473690962
+  dataset_size: 12687640571.75
+- config_name: punjabi
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 3054398341.146
+    num_examples: 21118
+  download_size: 3181612927
+  dataset_size: 3054398341.146
+- config_name: sanskrit
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 2036760741.337
+    num_examples: 14177
+  download_size: 2036474974
+  dataset_size: 2036760741.337
+- config_name: tamil
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 33855148157.352
+    num_examples: 281508
+  download_size: 31654328747
+  dataset_size: 33855148157.352
+- config_name: telugu
+  features:
+  - name: audio_filepath
+    dtype: audio
+  - name: text
+    dtype: string
+  - name: duration
+    dtype: float64
+  - name: lang
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 5722466966.018
+    num_examples: 56082
+  download_size: 5886818756
+  dataset_size: 5722466966.018
+configs:
+- config_name: assamese
+  data_files:
+  - split: train
+    path: assamese/train-*
+- config_name: bengali
+  data_files:
+  - split: train
+    path: bengali/train-*
+- config_name: dogri
+  data_files:
+  - split: train
+    path: dogri/train-*
+- config_name: gujarati
+  data_files:
+  - split: train
+    path: gujarati/train-*
+- config_name: hindi
+  data_files:
+  - split: train
+    path: hindi/train-*
+- config_name: kannada
+  data_files:
+  - split: train
+    path: kannada/train-*
+- config_name: konkani
+  data_files:
+  - split: train
+    path: konkani/train-*
+- config_name: maithili
+  data_files:
+  - split: train
+    path: maithili/train-*
+- config_name: malayalam
+  data_files:
+  - split: train
+    path: malayalam/train-*
+- config_name: marathi
+  data_files:
+  - split: train
+    path: marathi/train-*
+- config_name: nepali
+  data_files:
+  - split: train
+    path: nepali/train-*
+- config_name: odia
+  data_files:
+  - split: train
+    path: odia/train-*
+- config_name: punjabi
+  data_files:
+  - split: train
+    path: punjabi/train-*
+- config_name: sanskrit
+  data_files:
+  - split: train
+    path: sanskrit/train-*
+- config_name: tamil
+  data_files:
+  - split: train
+    path: tamil/train-*
+- config_name: telugu
+  data_files:
+  - split: train
+    path: telugu/train-*
+---
+
+# Shrutilipi: A Multilingual Speech and Text Dataset
+
+Shrutilipi is an open dataset by AI4Bharat that provides high-quality speech and text data for multiple Indian languages. The dataset is designed to support research and development in speech recognition, natural language processing, and related applications.
+
+## Overview
+
+Each data sample in the dataset includes:
+- **audio_filepath**: Path to the audio file.
+- **text**: Transcription of the audio.
+- **duration**: Duration of the audio recording (in seconds).
+- **lang**: Language identifier for the sample.
+
+The dataset is released under the [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
+
+## Configurations
+
+Shrutilipi is organized into several language-specific configurations. Each configuration contains a training split with the following details:
+
+- **assamese**
+  - Training examples: 41,766
+  - Dataset size: ~5.08 GB
+- **bengali**
+  - Training examples: 17,882
+  - Dataset size: ~1.97 GB
+- **dogri**
+  - Training examples: 23,721
+  - Dataset size: ~3.60 GB
+- **gujarati**
+  - Training examples: 137,965
+  - Dataset size: ~16.32 GB
+- **hindi**
+  - Training examples: 734,675
+  - Dataset size: ~97.82 GB
+- **kannada**
+  - Training examples: 192,208
+  - Dataset size: ~20.07 GB
+- **konkani**
+  - Training examples: 12,239
+  - Dataset size: ~1.25 GB
+- **maithili**
+  - Training examples: 22,233
+  - Dataset size: ~2.98 GB
+- **malayalam**
+  - Training examples: 224,323
+  - Dataset size: ~17.61 GB
+- **marathi**
+  - Training examples: 336,475
+  - Dataset size: ~42.35 GB
+- **nepali**
+  - Training examples: 31,997
+  - Dataset size: ~5.21 GB
+- **odia**
+  - Training examples: 126,675
+  - Dataset size: ~12.69 GB
+- **punjabi**
+  - Training examples: 21,118
+  - Dataset size: ~3.05 GB
+- **sanskrit**
+  - Training examples: 14,177
+  - Dataset size: ~2.04 GB
+- **tamil**
+  - Training examples: 281,508
+  - Dataset size: ~33.86 GB
+- **telugu**
+  - Training examples: 56,082
+  - Dataset size: ~5.72 GB
+
+For each configuration, the data files are organized under the corresponding language folder (e.g., `hindi/train-*`).
+
+## Data Format and Features
+
+For every configuration, the dataset includes:
+- **audio_filepath** (audio): Path to the corresponding audio file.
+- **text** (string): Transcription of the audio recording.
+- **duration** (float64): Length of the audio in seconds.
+- **lang** (string): Identifier for the language.
+
+## How to Use the Dataset
+
+Shrutilipi is fully compatible with the [Hugging Face Datasets](https://huggingface.co/docs/datasets) library. To load a particular language configuration, use the following example code:
+
+```python
+from datasets import load_dataset
+
+# Example: Load the Hindi configuration
+dataset = load_dataset("ai4bharat/Shrutilipi", "hindi", split="train")
+print(dataset)