add additional features

.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Mac OS
+.DS_Store

Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+datasets = "*"
+soundfile = "*"
+librosa = "*"
+
+[dev-packages]
+
+[scripts]
+test = "datasets-cli test ./tess.py --save_info --all_configs"
+
+[requires]
+python_version = "3.11"

README.md

@@ -1,16 +1,16 @@
 ---
-pretty_name: TESS
 annotations_creators:
 - expert-generated
-license: cc-by-nc-4.0
-task_categories:
-- audio-classification
 language:
 - en
+license: cc-by-nc-4.0
 multilinguality:
 - monolingual
 size_categories:
 - 1K<n<10K
+task_categories:
+- audio-classification
+pretty_name: TESS
 dataset_info:
   features:
   - name: path
@@ -21,8 +21,12 @@ dataset_info:
         sampling_rate: 24400
   - name: speaker_id
     dtype: string
+  - name: speaker_age
+    dtype: int8
   - name: text
     dtype: string
+  - name: word
+    dtype: string
   - name: label
     dtype:
       class_label:
@@ -36,17 +40,17 @@ dataset_info:
           '6': ps
   splits:
   - name: train
-    num_bytes: 946760
+    num_bytes: 1027470
     num_examples: 2800
   download_size: 224036453
-  dataset_size: 946760
+  dataset_size: 1027470
 ---
 
 # Dataset Card for Toronto emotional speech set (TESS)
 
 ## Dataset Description
 
-- **Homepage:** https://doi.org/10.5683/SP2/E8H2MF
+- **Homepage:** <https://doi.org/10.5683/SP2/E8H2MF>
 - **Point of Contact:** Pichora-Fuller, M. Kathleen (University of Toronto Mississauga)
 
 ### Dataset Summary
@@ -60,6 +64,7 @@ English
 ## Dataset Structure
 
 ### Data Instances
+
 ```json
 {
   'path': '.../.cache/huggingface/datasets/downloads/extracted/.../tess/OAF_back_angry.wav',
@@ -81,6 +86,16 @@ English
 }
 ```
 
+## Usage
+
+This repo uses custom code which must be executed to correctly load the dataset. You can, and should, inspect the [loading script](https://huggingface.co/datasets/myleslinder/tess/blob/main/tess.py).
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("myleslinder/tess", split="train", trust_remote_code=True)
+```
+
 ## Additional Information
 
 ### Citation Information

tess.py

@@ -75,7 +75,9 @@ class TessDataset(datasets.GeneratorBasedBuilder):
                 "path": datasets.Value("string"),
                 "audio": datasets.Audio(sampling_rate=sampling_rate),
                 "speaker_id": datasets.Value("string"),
+                "speaker_age": datasets.Value("int8"),
                 "text": datasets.Value("string"),
+                "word": datasets.Value("string"),
                 "label": datasets.ClassLabel(names=_CLASS_NAMES),
             }
         )
@@ -113,9 +115,11 @@ class TessDataset(datasets.GeneratorBasedBuilder):
                 audio_path = os.path.join(archive_path, _ROOT_DIR, filename)
                 examples[audio_path] = {
                     "path": audio_path,
-                    "speakerId": speakerId,
+                    "speaker_id": speakerId,
+                    "speaker_age": 64 if speakerId == "OAF" else 26,
+                    "text": f"Say the word {word}",
                     "word": word,
-                    "class": label,
+                    "label": label,
                 }
 
         id_ = 0