persephone icon indicating copy to clipboard operation
persephone copied to clipboard

Documentation update

Open oadams opened this issue 6 years ago • 6 comments

Things to document:

  • [ ] The need to build Kaldi for filterbank_and_pitch features.
  • [x] Need for settings.ini / include a default.
  • [ ] Model training arguments.
  • [ ] Use of train_prefixes.txt, valid_prefixes.txt, test_prefixes.txt
  • [x] Mention Python 3.7 is not supported by Tensorflow.
  • [x] Point users to Github issue tracker to raise problems.
  • [ ] Document assumptions about data, and how the tool is primarily aimed at the single-speaker scenario.

oadams avatar Oct 13 '18 12:10 oadams

Is there any test data for filterbank_and_pitches? I'm putting together environment build automation over in PR #208 and I'd like to be able to verify that I can automate the install of Kaldi by running some data through these code paths.

shuttle1987 avatar Oct 23 '18 07:10 shuttle1987

There's no data: the distinction between filterbank and filterbank_and_pitches is only that pitch features are extracted from the audio additionally, so a test for pitch extraction could use the same data as any existing test that extracts filterbank features.

oadams avatar Oct 24 '18 15:10 oadams

In that case perhaps we can just use an existing test set for the data but with the different parameters for this? I'd like to get some test that requires Kaldi to work

shuttle1987 avatar Oct 24 '18 16:10 shuttle1987

Yes, that's right.

oadams avatar Oct 24 '18 16:10 oadams

Is this issue related to #86 and #1 ?

shuttle1987 avatar Oct 29 '18 09:10 shuttle1987

Yeah, perhaps we should just enumerate current documentation change requirements in the checklist above, unless its really big enough and requires implementation that somehow warrants its own issue.

oadams avatar Oct 29 '18 13:10 oadams