Skip to content

Document about layer usages in xconfig #4577

Open
@eliphatfs

Description

@eliphatfs

The latest nnet3 setup for deep neural networks is intended for supporting the kinds of topologies that both the nnet1 and nnet2 code-bases support, and more; and to do so in a natural, config-file-driven way that should not require coding to support most interesting new ideas.

Indeed, it provides a easier way to view the architecture of networks written by others. However, as one, like me, new to kaldi, and willing to learn how to compose his/her own neural networks in kaldi, he/she may have problems with the xconfig. People are asking what's this and what's that on kaldi-help forum, for example, here and here. I think that there had better be a list of available layers (well, this can be found in xconfig/parser.py, but even better in documentation as it consumed hours for me to find that correct file) and moreover, the possible configurations and meanings of the configurations. Also, abbreviations such as numbers for Offset which is visible everywhere in examples but nowhere in the documentation give rise to much confusion.

Overall, the documentation seems to target expert developers willing to understand the mechanics inside kaldi, dealing with internals of C++ code. In contrast, scripting, which is actually what most newcomers and students do, seems to be loosely documented.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedPlease help us with this issue!stale-excludeStale bot ignore this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions