Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to add basic installation and usage patterns #97

Merged
merged 4 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Sphinx Build
uses: ammaraskar/sphinx-action@0.4
uses: ammaraskar/sphinx-action@7.0.1
with:
docs-folder: "docs/"

16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ This is a repository for the FAVE-Align and FAVE-extract toolkits.
The first commit here represents the toolkit as it was available on the FAVE website as of October 21, 2013.
The extractFormants code in the JoFrhwld/FAAV repository represents an earlier version of the code.

## Getting started

You can install FAVE using pip by running the following:
```
python3 -m pip install fave
```

While FAVE can align transcripts to audio data, we recommend using the [Montreal Force Aligner](https://montreal-forced-aligner.readthedocs.io/en/latest/first\_steps/index.html#first-steps-align-pretrained) for alignment because it is more recent and better maintained than the HTK library used by FAVE's aligner.

When you have an aligned TextGrid and the matching audio, you can extract acoustic measures by running the following:
```
fave-extract AudioFileName.wav TextGridFileName.TextGrid OutputFileName
```

Where `AudioFileName.wav` is the path to the audio file to measure, `TextGridFileName.TextGrid` is the path to the aligned TextGrid, and `OutputFileName` is the name of the file where you want your measurements to be output.

## Documentation
Current documentation for installation and usage available on the github wiki. [https://github.com/JoFrhwld/FAVE/wiki](https://github.com/JoFrhwld/FAVE/wiki)

Expand Down
Loading
Loading