Outreachy Documentation Project: <Betty Mirembe>

kbetty commented 2 years ago

Applicant: <Betty Mirembe, kbetty>

Welcome to the Ersilia Open Source Initiative. This issue will serve to track all your contributions for the project “Improve the documentation and outreach material of the Ersilia Model Hub”.

Please tick the tasks as you complete them. To make a final application it is not required to have completed all tasks. Only the Initial Steps and Community sections are REQUIRED. The tasks are not ordered from more to less important, they are simply related to different skills. Start where you feel most comfortable. This project can be adapted to the applicants interests, please focus on the type of tasks that you prefer / have better skills / would like to work on as an intern.

Initial steps:

[x ] Record your application for the project in the outreachy website referencing this issue. Please make sure to select the right project on the website.
[x ] Join the Slack channel to follow public communications
[ ] Comment under this issue explaining why are you interested in this project

GitHub documentation:
[ ] Create a README file with the name under the /documentation folder
[ ] Link the #PR in a comment under this issue
[ ] Incorporate feedback from the mentor

Writing dissemination material
[x ] Read the Strategic plan 2021-2023 for Ersilia and create a 1-page blogpost with the main points
[ ] Comment under this issue with a link to the blogpost (a google docs for example)
[ ] Incorporate feedback from the mentor
[ ] Choose your own topic related to Ersilia (AI/ML for biomedical research, neglected diseases, drug discovery…) and write a 1-page blogpost to communicate to a non-expert audience
[ ] Comment under this issue with a link to the blogpost (a google docs for example)
[ ] Incorporate feedback from the mentor
[ ] Create a template for a twitter post to release every time a new model is incorporated in the Hub (twitter: 280 characters, you can suggest a main post + thread with extra information) and add it as a comment under this issue
[ ] Create a template short Newsletter (1 paragraph) to send every month to our community (funders, users, contributors). It should mention metrics (models in the hub, number of users, funding…), thank you etc

Technical skills (required for the tutorial only)
[ ] Install the Ersilia Model Hub
[ ] Test one model
[ ] Add a screenshot under this issue showing the model running in your computer
[ ] Write a docstring for the ErsiliaModel class. Use the Google Python Style guide. Paste the docstring as a comment below (do not use a PR).

Graphic material
[ ] Read the Ersilia Brand Guidelines
[ ] Read “Why Ersilia?”
[ ] Create one image / slide to explain Ersilia’s mission and vision
[ ] Link to the image/slide as a comment under this issue
[ ] Incorporate feedback from the mentor
[ ] Create two slides / short video showing how to use the Ersilia Model Hub and add them under the /tutorial folder
[ ] Link the #PR in this issue
[ ] Incorporate feedback from the mentor

Scientific content
[ ] Check the models available in the Hub
[ ] Select one model from the list and write a technical card (what is the model for, what input, which data was used to create it, what kind of ML algorithm uses…) for it
[ ] Add your card as a comment to this issue
[ ] Search the scientific literature and suggest 3 new models (comment in this issue) that would be relevant to incorporate in the Hub.

Community
[ ] Look up two other projects and comment on their issues with feedback on one of their tasks
[ ] If you have feedback from your peers, answer it in this issue.

Other

If you have interest in working on related topics, or have new suggestions, please do the following
[ ] Add a comment in this issue with your new idea, tagging the mentor
[ ] Get feedback from the mentor and act accordingly
[ ] Link in the comments any other PR you have contributed to.

Final application
[ ] I have answered all comments from mentors and contributors
[ ] All PR or issues assigned to me are complete
[ ] I have submitted my final application to the project

Why am passionate about the project.

After taking a research and understood the goal of Ersilia Model Hub, I discovered that when our AI models are validated they are published for use but they lack the Deployment feature which can aid users to use the tool(s) with ease. Of which these users most of them are scientists who are actually not computer experts and this results into our tools not being widely adopted by the users.

As well went through presentations by @GemmaTuron which gave me a generic overview of Ersilia project and the project objectives.

So I am passionate to be part of the evolution of Improving the documentation and outreach material of the Ersilia Model Hub.

kbetty commented 2 years ago

Initial contributions:

I updated a created a folder for tutorials https://github.com/ersilia-os/ersilia/pull/32
I corrected a typo in the readme file https://github.com/ersilia-os/ersilia/pull/46
I updated the Readme file https://github.com/ersilia-os/ersilia/pull/55

kbetty commented 2 years ago

Have added a PR for the Readme file at https://github.com/ersilia-os/ersilia/pull/130 cc: @GemmaTuron

GemmaTuron commented 2 years ago

Hi @kbetty Thanks for your contribution. Here a few comments:

The logo is really big, I never managed to make it smaller in the original README file, if you know how to do it that would be great. Note that I did not manage to do it so it might be it is just difficult to work with images in readme files. Just asking here :)
Some links in the table of content are not pointing to the sections in your document but in the original files, can you change that?
Double check the repo license as there is an error in the readme file
Is there any other section you find missing, or piece of information that does not appear in the original file? I encourage you to think it and add any relevant sections that might be missing

kbetty commented 2 years ago

Thanks @GemmaTuron for your constructive feedback. Am going to work on the recommendations

GemmaTuron commented 2 years ago

Hi @kbetty

To prepare your final application, check the recommendations for the readme file and choose one task from the rest of the list if you want, or go ahead to create your final application in the website. Please link this issue on the application page as well!

GemmaTuron commented 2 years ago

The Outreachy contribution period has come to an end, so I will close this issue. If you want to continue contributing to Ersilia, please follow the guidelines in the CONTRIBUTING file

ersilia-os / ersilia

Outreachy Documentation Project: <Betty Mirembe> #110

Initial steps:

[ ] Comment under this issue explaining why are you interested in this project

GitHub documentation:

[ ] Incorporate feedback from the mentor

Writing dissemination material

[ ] Create a template short Newsletter (1 paragraph) to send every month to our community (funders, users, contributors). It should mention metrics (models in the hub, number of users, funding…), thank you etc

Technical skills (required for the tutorial only)

[ ] Write a docstring for the ErsiliaModel class. Use the Google Python Style guide. Paste the docstring as a comment below (do not use a PR).

Graphic material

[ ] Incorporate feedback from the mentor

Scientific content

[ ] Search the scientific literature and suggest 3 new models (comment in this issue) that would be relevant to incorporate in the Hub.

Community

[ ] If you have feedback from your peers, answer it in this issue.

Other

[ ] Link in the comments any other PR you have contributed to.

Final application

Why am passionate about the project.