Skip to main content

ChildProject

PyPI GitHub tests Travis CI Status ReadTheDocs License

Introduction

Day-long (audio-)recordings of children are increasingly common, but there is no scientific standard formatting that can benefit the organization and analyses of such data. ChildProject provides standardizing specifications and tools for the storage and management of day-long recordings of children and their associated meta-data and annotations.

File organization structure

We assume that the data include three very different types:

  1. Audio, of which we distinguish the raw audio extracted from the hardware; and a version that has been converted into a standardized format. These audios are the long-form ones. At the time being, we do not foresee including clips extracted from these long-form audios, and assume that any such process will generate some form of annotation that can then be re-cast temporally to the long-form audio.
  2. Annotations, of which we again distinguish raw and standardized versions. At present, we can import from Praat's textgrid, ELAN's eaf, and VTC's rttm format.
  3. Metadata corresponding to the children, recordings, and annotations, which will therefore also describe the converted recordings.

Available tools

Day-long audiorecordings are often collected using a LENA recorder, and analyzed with the LENA software. However, open source alternatives to the LENA commercial environment are emerging, some of which are shown in the following figure.

Overview of some tools in the day-long recordings environment

For instance, alternative hardware includes the babylogger and any other light-weight recording device with enough battery and storage to record over several hours.

Alternative automated analysis options include the Voice Type Classifier, which segments the audio into different talker types (key child, female adult, etc) and ALICE, an automated linguistic unit counter.

As for manual annotation options, ELAN can be used, for instance employing the ACLEW DAS annotation scheme. Assignment of annotation to individuals and evaluation can be done using Seshat. Finally, Zooniverse can be used to crowd-source certain aspects of the classification with the help of citizen scientists.

In this context, we provide tools and a procedure to:

  • Validate datasets (making sure that metadata, recordings and annotations are in the right place and format)
  • Convert your raw recordings into the desired format
  • Import annotations (from the LENA, ELAN, Praat, VTC/ALICE/VCM rttms, CHAT files) into a standardized format
  • Generate reliability metrics by comparing annotators (confusion matrices, agreement coefficients, pyannote metrics)
  • Extract metrics from the annotations (e.g. average vocalization rates, durations, etc.)
  • Sample segments of the recordings to annotate from a set of sampling algorithms
  • Add clips to an annotation pipeline in Zooniverse, and retrieve the ensuing annotations

These tools can be used both in command-line or from within your python code, by importing our modules.

Installation

You can find instructions to install and use our package in our documentation.

Citation

If you are using this project for your research, please cite our introductory paper:

@article{gautheron_rochat_cristia_2021,
    title={Managing, storing, and sharing long-form recordings and their annotations},
    url={https://link.springer.com/article/10.1007/s10579-022-09579-3},
    DOI={10.1007/s10579-022-09579-3},
    publisher={Springer},
    journal={Language Resources and Evaluation}
    author={Gautheron, Lucas and Rochat, Nicolas and Cristia, Alejandrina},
    year={2022},
    month={Feb}
}

Metadata

Release files for ChildProject 0.4.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ChildProject 0.4.6
File Size Uploaded
childproject-0.4.6.tar.gz 141.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ChildProject 0.4.6
File Interpreter ABI Platform
childproject-0.4.6-py3-none-any.whl Python 3 none any Details

Total release size: 271.1 kB

Release files / childproject-0.4.6.tar.gz

Download URL childproject-0.4.6.tar.gz
Size 141.0 kB
Tags Source
SHA-256 checksum
How to use checksums
cf78d3224bfe1f196793089be8d674575e241fad039e9412e2303f6b69595fdd
BLAKE2b-256 checksum
How to use checksums
49cb413dbfe8b183d4cf2b2bea5fdbe729e2457859b2852fac8a12c4906ad4be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / childproject-0.4.6-py3-none-any.whl

Download URL childproject-0.4.6-py3-none-any.whl
Size 130.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
51c2d02f86eda5a0a7e6213c40a17b45e9e660e5cd49878612d9031996350c33
BLAKE2b-256 checksum
How to use checksums
2c31be850a9fafbbba75f84d317bee9692d1617bb3dfa051a88cbb9fd0b23f40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

0.4.6 This release

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page