-
-
Notifications
You must be signed in to change notification settings - Fork 38
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
[REVIEW]: ICAT: The Interactive Corpus Analysis Tool #6873
Comments
Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks. For a list of things I can do to help you, just type:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
Software report:
Commit count by author:
|
Paper file info: 📄 Wordcount for ✅ The paper includes a |
|
License info: ✅ License found: |
Hi @WarmCyan! Would you please be able to address the missing DOIs in the references? |
Review checklist for @SamHamesConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hello @JBorrow! I've added DOIs for all except ipyvuetify, I couldn't find anything for that one |
@SamHames thanks for agreeing to review this! Just so you're aware if you start playing with the software soon, there's a couple weird issues going on right now with dependencies that I'm still trying to resolve, if you run into problems during setup I'm tracking them over here: ORNL/icat#44 |
Hi all, I am in contact with the authors. They have been actively working to fix some issues in the repository (broken package dependencies die to updates). I'll investigate the fixes and latest end of next week. I provide my checklist here then too. Thanks for your patience. |
Review checklist for @jhagerer (-> still in process!!!)Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
This review is still in process. Issues with the code repository still have to be analyzed and fixed, see ORNL/icat#44. |
Hi all, just checking in that the responses to the review items are progressing? |
Hey @JBorrow! We've determined in ORNL/icat#44 that ICAT doesn't run in vscode (which is somewhat expected/outside of what I'm trying to support.) I'm not sure if @jhagerer has had a chance to take a look at it since, but I'm waiting to see if it runs correctly for him in Jupyter Lab. |
@WarmCyan I got icat running successfully. However, it looks honestly not fully usable, since I cannot recognize the text on the right, and also the illustration could be improved: As you see, I used Jupyter Notebook and Jupyter Lab. Both look not ideal, even though both are recommended in the official documentation. What is your comment on that with regards to usability and correct display? Further, I think it would be good to give a hint somewhere in the documentation that Visual Studio Jupyter code cells should not be used. Last but not least, I would recommend an advanced example that does not require transformers with a CUDA/NVIDIA hardware, but maybe something more lightweight but still reasonable and computationally efficient, e.g., word2vec. I am giving this advice, since I would really like to use and understand this tool, but I would be afraid that users might experience unnecessarily difficult entry barriers, which would undermine the efforts already made by the authors. |
@jhagerer yeah this is a good point, I didn't do due diligence in making sure it looks right in light mode as well, and that certainly has a huge impact on usability. The jarring mismatch of colors and inability to read the text should be fixable by checking for light/dark theme and adjusting interface coloring accordingly. To address the scrolling/crampedness of the jupyter notebook cells, I'll add a check for notebook vs lab and auto-scale components to make sure they fit. I've opened an issue to track this here: ORNL/icat#45 and will try to make both of these changes within the next week or two. |
That's also a good point about an additional example notebook that doesn't need transformers to run, I've opened an issue for it here: ORNL/icat#46 |
I can confirm that the authors addressed my feedback. Now it is my job to try out the tools and go through its documentation in order to finish the peer review. |
Excellent! Let me know if there is anything else any of you need, or if there are any further questions. |
Submitting author: @WarmCyan (Nathan Martindale)
Repository: https://github.com/ORNL/icat
Branch with paper.md (empty if default branch):
Version: v0.7.2
Editor: @JBorrow
Reviewers: @SamHames, @jhagerer
Archive: Pending
Status
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) by leaving comments 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
@SamHames & @jhagerer, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @JBorrow know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Checklists
📝 Checklist for @SamHames
The text was updated successfully, but these errors were encountered: