Skip to content
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

MRG: Pyglmnet paper #313

Merged
merged 40 commits into from
Nov 23, 2019
Merged

MRG: Pyglmnet paper #313

merged 40 commits into from
Nov 23, 2019

Conversation

jasmainak
Copy link
Member

@jasmainak jasmainak commented Sep 18, 2019

closes #297

Hi everyone,

@pavanramkumar and I created a first draft of our paper for submission to JOSS. If you want to be listed as an author, please read the draft and leave comments. More importantly:

  • Check and/or update your name, affiliation and ORCID by leaving a "code suggestion"
  • Add to the acknowledgement section any grants that enabled you to contribute to pyglmnet
  • If you are a contributor but your commits don't show up in the contributor graph please make sure that you have the email id that you used to commit in your verified emails on Github. The instructions to do this are here

The guidelines for JOSS submission are here.

Compiling the paper

If you want to compile the paper
- go to: https://whedon.theoj.org/
- in the paper repository address, enter: https://github.com/jasmainak/pyglmnet/
- in the custom branch, enter: paper

Compile!

Tagging all contributors (check mark if we got a response)

@codecov-io
Copy link

codecov-io commented Nov 2, 2019

Codecov Report

Merging #313 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #313   +/-   ##
=======================================
  Coverage   75.66%   75.66%           
=======================================
  Files           4        4           
  Lines         678      678           
  Branches      149      149           
=======================================
  Hits          513      513           
  Misses        128      128           
  Partials       37       37

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 243959c...8bc250f. Read the comment docs.

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
@pavanramkumar
Copy link
Collaborator

Thanks @jasmainak ! Looks good to me

@jasmainak jasmainak changed the title WIP: Pyglmnet paper MRG: Pyglmnet paper Nov 3, 2019
@jasmainak
Copy link
Member Author

hi @themantalope can you read the first comment and confirm your authorship by checking the affiliation and adding the orcid? Thanks.

@koerding
Copy link

koerding commented Nov 8, 2019 via email

@jasmainak
Copy link
Member Author

no worries, we are expecting you to make at least two pull requests since you are taking extra time now ;)

@koerding
Copy link

koerding commented Nov 8, 2019 via email

@jasmainak
Copy link
Member Author

jasmainak commented Nov 9, 2019

@AnchorBlues @BeibinLi @DreHar @the872 @themantalope @marquesVF @evadyer @tommyod @ravigarg27 @timshell

I have not heard from you in this thread. We do need you to confirm your name and affiliation if you want to be included as an author.

@daniel-acuna
Copy link
Collaborator

@jasmainak I am in a conference with one of the assoc. editors in chief of JOSS. perhaps there is some way of receiving feedback? maybe email me to [email protected]

@pavanramkumar
Copy link
Collaborator

Thanks @daniel-acuna for offering to do this. The JOSS review process seems super straightforward and transparent: one of the reasons why we chose the venue. @jasmainak will be in touch!

@themantalope
Copy link
Contributor

themantalope commented Nov 10, 2019 via email

@timshell
Copy link
Contributor

Name and affiliation are good for me. Thanks for including me! Not sure why I'm not showing up in the contributor graph. Perhaps the e-mail I used for that was my undergraduate university e-mail (which I don't have access to anymore)

@jasmainak
Copy link
Member Author

@timshell okay then we have to do this by updating the .mailmap. Are you up to make a PR to fix it? If not, just tell me your new email address and I'll do it.

@jasmainak jasmainak mentioned this pull request Nov 11, 2019
4 tasks
@BeibinLi
Copy link
Contributor

Thanks! I would like to be part of this. My name and affiliation look all right.

@tommyod
Copy link
Contributor

tommyod commented Nov 12, 2019

Verifying that my name and affiliation is correct as written. Thanks!

Copy link
Contributor

@tommyod tommyod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Felt a bit guilty about having my name on something where I haven't contributed, so I added some quick comments. Hope it's helpful. I also hope to look more at the code in the future. Haven't had need to use GLMs in a while. Great work. 👍

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated
| Group lasso | x | | | x | | | x |
| Tikhonov | x | | | | | | |

Pyglmnet implements the same algorithm described in [Friedman, J., Hastie, T., & Tibshirani, R. (2010)](https://core.ac.uk/download/files/153/6287975.pdf>) and the accompanying widely popular R package [glmnet].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"...implements the algorithm described in..." or "...implements the same algorithm as described in..."

paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated Show resolved Hide resolved
paper/paper.md Outdated
important to regularize the model to avoid overfitting the data.
Regularization works by adding penalty terms that penalize the model parameters in
a variety of different ways. This can be used to incorporate prior knowledge
about the parameters in a structured form. In Pyglmnet, we offer
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pyglmnet -> pyglmnet

comment from @DreHar

@ravigarg27
Copy link
Contributor

Thank you for including me. My name and affiliation are right.

* adding email

* Update .mailmap

Co-Authored-By: Mainak Jas <[email protected]>
@AnchorBlues
Copy link
Contributor

Thanks for including me for the paper.

I verified that my name and affiliation are correct.

@the872
Copy link
Contributor

the872 commented Nov 18, 2019

Thanks for the update, will be happy to represent the Loyola University Chicago commits.

@pavanramkumar
Copy link
Collaborator

@the872 thanks! any idea how we can reach out to @marquesVF -- pending confirmation needed from him

@marquesVF
Copy link
Contributor

marquesVF commented Nov 19, 2019

Hi guys!

Thanks for reaching me. That's correct. I was at Loyola.

I would only suggest to use my full name as Vinicius de F. Marques
Thanks and great work!

@pavanramkumar

@pavanramkumar pavanramkumar merged commit dc89e29 into glm-tools:master Nov 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

preparation for JOSS paper