Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
[REVIEW]: UralicNLP: An NLP library for Uralic Languages #1345
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@gweissman, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
Review checklist for @gweissman
Conflict of interest
Code of Conduct
referenced this issue
Mar 22, 2019
If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews
To fix this do the following two things:
For a list of things I can do to help you, just type:
@arfon This my first time reviewing for JOSS so still trying to learn the checklist, which I have completed above. Additional comments I would like to include in the review are:
@gweissman It seems that you do not have VISL CG-3 installed. It is required for constraint grammars and unfortunately cannot be installed over pip as a dependency. This requirement has been stated in the readme file.
I think that adding an indicator (or a progress bar) for downloading the models is a great idea. Thanks for the suggestion.
@gkthiruvathukal I have completed my review. Some of the check boxes I am unable to adequately assess. For example, I don't speak or read any of the languages in question so I can't make claims about functionality of the software.
As far as DOIs go, I have improved the situation with the latest version of UralicNLP. It is now possible to use uralicApi.model_info("fin") which will output information about the authors, copyright and such details. At least this will output a url to the Giellatekno repository where the FST and CG models are from. I have also gathered as much information as possible from the files in the Giellatekno repository in the model_info function. Sadly, it is quite common that the AUTHORS and LICENCE files are empty (see https://victorio.uit.no/langtech/trunk/langs/nob/ for example)
I have added CONTRIBUTING.md to the repository.
Also, I have improved the coverage of the automated tests (see https://github.com/mikahama/uralicNLP/blob/master/travis_test.py), however I do admit that more work should be done here to cover all the functionalities.
@mikahama — I'm going to ask for a little clean-up on your bibliography. When you have acronyms, like NLP, you should use caps protection only around that string, i.e.,
For two entries, I found you can add a DOI or permalink:
Here's what you must now do:
Any issues? notify your editorial technical team...
If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation:
We need your help!
Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following: