PyDP
PyDP copied to clipboard
OpenMined
Update the Examples Readme
Where?
https://github.com/OpenMined/PyDP/tree/dev/examples
Who?
Anyone looking for PyDP examples/demo
What?
Example/demo sub-title with short description and link.
Hi! Sorry, I didn't understand what is to be done. Do new examples have to be added?
@LiviaCavalcanti if you check it the readme is pretty much outdated. Need to update it with all the examples/demos that have been added, with a little description for the viewer to know which example/demo does what.
Hope this answers your question.
Hi @LiviaCavalcanti Adding to Shaishta's comment, if you visit Readme in examples, you will find that it only houses 1 demo, even though we have 3 demos, so we are looking to add a description of these demos in the readme.
Hi @chinmayshah99 I would like to take up this issue since @AkashM398 is inactive for quite a while as per our conversation in slack.
Sure.
On Fri, 30 Oct 2020 at 16:34, Rajatendu Dey [email protected] wrote:
Hi @chinmayshah99 https://github.com/chinmayshah99 I would like to take up this issue since @AkashM398 https://github.com/AkashM398 is inactive for quite a while as per our conversation in slack.
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/OpenMined/PyDP/issues/312#issuecomment-719488164, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACTTOFO6OOTQSPTZADAQZFLSNKMSZANCNFSM4SXCNBWA .
-- Regards
Chinmay Shah
I have added the examples in the main project README.md as well as added the description in the respective folders of the examples. Have a look and notify me of any changes if needed. @chinmayshah99
PTAL @Rajatendu1 https://github.com/OpenMined/PyDP/pull/320#issue-513094544 Thanks!
https://x-team.com/blog/how-to-write-a-great-readme/ - "How to write a great README" - it may be helpful
What to Include in Your README
Here are some of the essential things to include when you're writing your README. We'll assume that you're familiar with markdown to organize your file and make it look good.
- Title (can be text or an image)
- Introduction (what it's about & why you wrote it)
- How to install
- How to use
- Technologies used (libraries & versions, helps recruiters)
- Acknowledgments
Those are the absolute essentials. They make for a good README. If you want to write a great one, you can take it a step further and include:
- Table of contents (useful if your README is long)
- List of features
- Examples of use (with code or images)
I'd also recommend the Google style doc that many folks use to write better READMEs and docs: https://developers.google.com/style (formatting, style, language, grammar)
Hi @Rajatendu1 @shaistha24 @chinmayshah99 Would it be good to use something like jupytext to convert the notebook(s) into Markdown and then include the most important bits in the READMEs?
Currently, like in the Laplace demo README PR - https://github.com/OpenMined/PyDP/pull/318/files - there are mentions of different sections of the notebook without examples which may make it hard to follow, I think.
And, if some of the introductory work has been done in the notebook, it can be ported over into a README to improve the process of making "better READMEs" (as per https://x-team.com/blog/how-to-write-a-great-readme/):
- Title (can be text or an image)
- Introduction (what it's about & why you wrote it)
- How to install
- How to use
- Technologies used (libraries & versions, helps recruiters)
- Acknowledgments
As mentioned before, the Google style doc is great for writing better READMEs and docs: https://developers.google.com/style (formatting, style, language, grammar). Check out the Microsoft style too - https://docs.microsoft.com/en-us/style-guide/welcome/ 👍
In addition, I'd recommend running the text through a free grammar checker (Google Docs them) before submitting any PRs.
the template to follow for readme is this in general for the main readme is this https://github.com/OpenMined/.github/blob/master/README-TEMPLATE.md just in case.
@8bitmp3 Yes, what you have listed definitey makes sense and is easy to follow for the viewers.
Jupytext seems like a good idea to scrape the Notebook for the info we want to put on the README with less efforts and faster results.
I myself follow Google style docs most of the times. And would highly recommend that to all. As for the Grammar check, Grammarly kinda works best for me.
Is completing the "Good First Issue" necessary to get involved in the GSoC 2021, if yes, I'd like to be assigned with this open issue.
Yeah!
Regards
Chinmay Shah
On Thu, Apr 8, 2021, 21:40 Nabanita Dash @.***> wrote:
Is it available?
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/OpenMined/PyDP/issues/312#issuecomment-815952599, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACTTOFOXMZNZVW74NLWY7TDTHXIOVANCNFSM4SXCNBWA .
I'd like to work on this Issue. To be the specific the laplace_demo could do with some love ❤️, for instance, some LaTeX in the Notebook is broken and it doesn't have a README in the first place.
CC: @shaistha24 / @chinmayshah99 (Sorry for the @ 😅)
@chinmayshah99 Can I also take up the Titanic_demo ? It doesn't have a README and the notebook should have a TOC as well.
Sure.
Regards,
Chinmay Shah
sent from mobile device
On Sat, Dec 18, 2021, 21:48 Saurav Maheshkar @.***> wrote:
@chinmayshah99 https://github.com/chinmayshah99 Can I also take up the Titanic_demo ? It doesn't have a README and the notebook should have a TOC as well.
— Reply to this email directly, view it on GitHub https://github.com/OpenMined/PyDP/issues/312#issuecomment-997225428, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACTTOFMUYVN7QIWBRJQ4I3LURSX67ANCNFSM4SXCNBWA . You are receiving this because you were mentioned.Message ID: @.***>