search

TWOEARS / documentation

Documentation of the Two!Ears Auditory Model
http://docs.twoears.eu/
Creative Commons Attribution 4.0 International
13 stars 11 forks source link

Documentation on training of knowledge sources #51

Open hagenw opened 7 years ago

hagenw commented 7 years ago

This issue is a high-level question on how to handle the documentation in general. The seperate training procedures will be handled independently afterwards.

From the list of learned models for our database I identified the following knowledge sources that use trained data:

DnnLocationKS
GenderRecognitionKS
GmmLocationKS
GmtkLocationKS
IdentityKS
NumSrcsKS
IdLocKS
ItdLocationKS
LocationKS
SegmentationKS
StreamSegregationKS

Looking at https://github.com/TWOEARS/blackboard-system/tree/master/src/knowledge_sources I assume this list might be wrong or is not complete. Could you please correct the list.

In addition, we have to discuss how and where we want to document the generation of this training data. At the moment we have this section http://docs.twoears.eu/en/latest/blackboard/training/ where we have one subsection for training of the localisation knowledge sources and one for the identification knowledge sources, but both are not filled with text yet. Should we go with this structure and place all the information under this section?

Another question is if we should handle https://github.com/TWOEARS/Auditory-Machine-Learning-Training-and-Testing-Pipeline different then the other as it is a very poweful and hugh tool by itself?

/CC: @ivo--t, @kashefy, @ningma97, @chrschy

kashefy commented 7 years ago

@hagenw ,

IdentityKS is correct and should remain in this list NumSrcsKS should be NumberOfSourcesKS IdentityLocationKS is missing, these too are trained models.

AMLTTP is used for the training of IdentityKS, `NumberOfSourcesKS, IdentityLocationKS. We were thinking of putting the documentation of AMLTTP on the same level as binsim, AFE and blackboard. Is this ok? The AMLTTP documentation would cover the details of training the above models. For http://docs.twoears.eu/en/latest/blackboard/training/, we would add very brief text for training each KS with a link to the more elaborate documentation in the AMLTTP docs. We think this allows the AMLTTP docs to be self contained, reduces duplication of text, but still allows the reader to find the necessary doc regardless of where they start from.

Does this make sense?

ningma97 commented 7 years ago

@hagenw The list looks OK to me

hagenw commented 7 years ago

Here is an update of the list, I incorporated @kashefy proposal and renamed NumSrcsKS and IdLocKS accordingly, in addition I removed GmtkLocationKS and LocationKS as those are deprecated:

DnnLocationKS     => ningma97
GenderRecognitionKS    => chrschy
GmmLocationKS    => ningma97
IdentityKS    => kashefy
NumberOfSourcesKS    => kashefy
IdentityLocationKS    => kashefy
ItdLocationKS    => hagenw
SegmentationKS (outdated?)   => chrschy
StreamSegregationKS    => chrschy

I think it is a good idea to create an entry for the AMLTTP on the main level as it is such a big tool now. Regarding the brief texts on the training of the single knowledge sources, we could also think of including it directly to the documentation of the single knowledge sources. But on the other hand, you don't need to train them yourself in order to use them, so maybe we stick with http://docs.twoears.eu/en/latest/blackboard/training/ for the short texts.

So, I would propose to create a separate pull request for AMLTTP and then single ones for the texts under http://docs.twoears.eu/en/latest/blackboard/training/. I added names to the corresponding knowledge sources in the list above, those persons should create the corresponding pull requests and write the text. Please complain if you think I assigned you wrongly for some of the knowledge sources.

ivo--t commented 7 years ago

@hagenw , SegmentationKS is deprecated as far as I know (@chrschy to confirm), and StreamSegregationKS was coded by @chrschy hence I suggest he writes documentation about it.

hagenw commented 7 years ago

Ok, I adjusted the list accordingly and will contact @chrschy.

chrschy commented 7 years ago

SegmentationKS is indeed deprecated but the interfaces are more or less the same for StreamSegregationKS. I will update the corresponding documentation accordingly.

ningma97 commented 7 years ago

GenderRecognitionKS should be assigned to @chrschy

hagenw commented 7 years ago

I updated the list accordingly.