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

Hello, here to help! #1

Open
nrbgt opened this issue Jul 10, 2020 · 2 comments
Open

Hello, here to help! #1

nrbgt opened this issue Jul 10, 2020 · 2 comments

Comments

@nrbgt
Copy link

nrbgt commented Jul 10, 2020

Hello @nesarasr! 👋

I'm the GTRI "faculty" 🤓 that is helping out on the @smileey's Small Bets program.

I can help out with any stuff related to defining and maintaining environments, code review, etc. Feel free to make new issues, or just comment here!

Down the road, once you are comfortable with this work, I'd love to be able to

Good Luck! ✨

@nesarasr
Copy link
Collaborator

Hey @nrbgt ! Thanks a lot
I have uploaded most of my codes here on this repo. I am still in the process of editing them, and I'd love to hear your feedback and suggestions on how I can improve my codes to be more readable and user-friendly.
Thanks again,

@nrbgt
Copy link
Author

nrbgt commented Jul 23, 2020

Cool!

It'll be a bit before I can do a deep dive on your notebooks, but some first things that jump out at me:

  • you've got a couple __pycache__ folders: they don't hurt anything, but they also don't help readability/reproducibility/reusability.

I recommend creating and checking in a .gitignore file like so:

.ipynb_checkpoints/
__pycache__/

and then forcibly removing those offending files from the repo.

This will hide them from git so they don't show up in the UI, searches, etc.

Hooray notebooks! A quick scan reveals you have some markdown, and some nice output plots. Good show! I recommend adding links, with a short description, to each of them in your README.md.

Organizing and managing code in notebooks present a few special problems (I'm a Jupyter core contributor, so I've heard ALL ABOUT IT from EVERYONE). I can recommend importnb (disclaimer: co-author) which might allow you to reuse components of your notebooks. This also helps ensure that they are "restart and run all"able.

To keep yourself honest, I also recommend building up a minimal environment.yml which captures all your dependencies. I can help with this. While the repo is private, it won't make much of a difference, but if you were to make it public, it would be enough for someone to be able to try out your code on binder without spending the time to get a working environment.

Good luck! Will revisit more thoroughly soon...

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

No branches or pull requests

2 participants