Update paper.md, mailmap and small URL fix #359
Conversation
Codecov Report
@@ Coverage Diff @@
## master #359 +/- ##
=======================================
Coverage 75.66% 75.66%
=======================================
Files 4 4
Lines 678 678
Branches 149 149
=======================================
Hits 513 513
Misses 128 128
Partials 37 37Continue to review full report at Codecov.
|
|
@jasmainak @pavanramkumar I fixed some text and typos in |
|
thank you @titipata! i added some minor wordsmithing changes. @jasmainak looks good to merge for me! |
|
thanks for editing @pavanramkumar! After this PR, it should be ready for JOSS submission. The writing is much better now. |
paper/paper.md
Outdated
|
|
||
| # Example Usage | ||
|
|
||
| Here we apply pyglmnet to a real-world example. The Community and Crime dataset, one of 400+ datasets curated by the UC Irvine Machine Learning Repository [@Dua:2019] provides a highly curated set of 128 demographic attributes of US counties that may be used to predict incidence of violent crime. The target variable (violent crime per capita) is normalized to lie in $[0, 1]$. Below, we demonstrate the usage of a binomial-distributed GLM with elastic net regularization. | ||
| Here, we apply pyglmnet to predict incidence of violent crime from the Community and Crime dataset, one of 400+ datasets curated by the UC Irvine Machine Learning Repository [@Dua:2019] provides a highly curated set of 128 demographic attributes of US counties. The target variable (violent crime per capita) is normalized to the range of $[0, 1]$. Below, we demonstrate the usage of a pyglmnet's binomial-distributed GLM with elastic net regularization. |
There was a problem hiding this comment.
The first sentence reads weird. We're missing a "which"?
There was a problem hiding this comment.
yes, it should be "which provides". Can you do a quick edit on that?
There was a problem hiding this comment.
Sure, I will to do that.
Btw, note for the future -- it is not a good idea to make PRs from master. Maybe we should add it to our contributing guide. Because as the repository owner, if I push to your master then your master on origin is not a simple fast forward merge from upstream master. So if you accidentally pull from origin instead of upstream, you may have a bad master branch locally. Also, if I force push to this branch, it can close the pull request (recent experience of a lab colleague).
There was a problem hiding this comment.
@jasmainak nevermind, I did a fix according to your comment!
There was a problem hiding this comment.
lol okay, we don't need to bother about the story above then :)
There was a problem hiding this comment.
@jasmainak Yeah, totally agree, I shouldn't make PR from the master branch! I will make PR from my branches for the future PRs.
|
Merged, thanks @titipata and @pavanramkumar ! |
|
@jasmainak @pavanramkumar should we tag the reviewer and editor in JOSS to do a final review then? |
|
@titipata I am going to try to see if I can improve the example in the readme. One of the reviewers mentioned it as a "good to have". Then we can reply to the editor in the JOSS issue :) Will try to get it done by tonight. |
|
@jasmainak Awesome! I saw the comment on that. Feel free to tag me to review the PR :) |
paper.md