-
Notifications
You must be signed in to change notification settings - Fork 11
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
Better documentation of module relations, data requirements, output formats #19
Comments
@dlazesz Balázs, I guess |
@sassbalint thanks for picking up this issue!
You mean for replacing |
For the record. The FIG is meant to be edited and then converted to the PDF. Bálint (@sassbalint) used to maintain the FIG. As both Bálint and I have been left the project. I proposed that Noémi (@vadno) could do a one-time rewrite in Tikz to enable it for others to edit it more conveniently in the future as new modules emerge. I do not want to speak on her behalf. I have no other ideas how it would be easier for everybody to maintain the figure or who would actually do it in the first place. All ideas, suggestions and applications for maintaining are welcome! @beepsoft You could send PRs on the documentation (or any part of the project) if you have any ideas how to improve it. |
As @dlazesz mentioned, I'll draw a tikz version of the figure. |
Thank you, @vadno Noémi. :) While, as Balázs put it, "one-time rewrite in Tikz to enable it for others to edit it more conveniently in the future" sounds good, I guess that there is a chance that by creating the Tikz version you just take over this task for a long time, in practice. Are you OK with this? :) |
@sassbalint No, I'm not OK with this :) |
UPDATE: Hope it can handle better the growing number of modules. I keep this issue open as the current update does not solve the OP just tries to ease the situation. More documentation is on its way. |
emtsv is a really great tool, thanks for your work!
I'm all new to NLP so maybe that's the reason for all my problems, but only reading the documentation it is rather difficult to work effectively with
emtsv
One main thing I miss from the documentation is what each module's input and output is:
https://github.com/dlt-rilmta/emtsv#modules
For example, if I want to use the
chunk
module I don't know what data it needs so that it can run.Starting naively like this:
... I get this error:
That's fine, but which module will generate
'form', 'xpostag'
? After some trial and errors I could figure out that I needtok,morph,pos,chunk
, but this is a tedious way to find it out.The topology description is somewhat helpful (https://github.com/dlt-rilmta/emtsv/blob/master/docs/emtsv_modules.pdf) but it uses the "package names" instead of the module names expected by
emtsv
. Eg. it containsemToken
while inemtsv
it needs to be referenced astok
.It would also be great to know what each column in the result actually means and how these columns should be interpreted. This is also something really difficult to find out even after reading a lot of publication related to
emtsv
ande-magyar
.So, a nice documentation structure for someone just getting started with
emtsv
would be something like this:emtsv
(tok, morph, etc)form
,anas
,xpostag
, etc.)1-2. is already available, 3. and 4. is what I am missing.
The text was updated successfully, but these errors were encountered: