ersilia icon indicating copy to clipboard operation
ersilia copied to clipboard

📑 Feature Request: Google Colab Guide

Open GemmaTuron opened this issue 2 years ago • 133 comments

Is your feature request related to a problem? Please describe.

We need to improve the documentation to use Google Colab. There are three main actions that could be done:

  • [ ] Write a comprehensive guide
  • [ ] Improve the notebook template
  • [ ] create a small video/presentation

Describe the solution you'd like.

Some contributors to work together to improve this. I would suggest using a google docs to create the guides where participants can contribute. Each of the three tasks could have a leader that guides the development and then the others can contribute to it.

Describe alternatives you've considered

No response

Additional context.

No response

GemmaTuron avatar Oct 18 '22 09:10 GemmaTuron

Hello,

I think this coulb be tackled by a few of the Outreachy applicants that are already advanced on the tasks: @ZakiaYahya @sayantani11 @malikbadmus @pauline-banye @Cee-tech21 ...

the fact that I am not adding your name here does not mean you can't contribute. Who wants to take the lead in these sections?

GemmaTuron avatar Oct 18 '22 09:10 GemmaTuron

Hi @GemmaTuron, I think this is a fantastic idea. I don't mind taking the lead on creating a video presentation for how to fetch models and predict models successfully on colab

paulinebanye avatar Oct 18 '22 10:10 paulinebanye

I think we could run through the very beginning, from the download csv to the prediction/calculation 🤔

paulinebanye avatar Oct 18 '22 10:10 paulinebanye

Hello @GemmaTuron, this is a very fantastic concept, I will like to work on the comprehensive guide.

Is anyone also interested in working with me on this?

Malikbadmus avatar Oct 18 '22 10:10 Malikbadmus

@GemmaTuron i would love to work on comprehensive guide.

ZakiaYahya avatar Oct 18 '22 10:10 ZakiaYahya

Hello @GemmaTuron, this is a very fantastic concept, I will like to work on the comprehensive guide.

Is anyone also interested in working with me on this?

yes, i'm interested in co-lead with you @Malikbadmus :)

ZakiaYahya avatar Oct 18 '22 10:10 ZakiaYahya

Great @Malikbadmus @ZakiaYahya you have the comprehensive guide covered 👍!

paulinebanye avatar Oct 18 '22 10:10 paulinebanye

I created a doc where we can input suggested changes @ZakiaYahya @sayantani11 @Malikbadmus @Cee-tech21

paulinebanye avatar Oct 18 '22 11:10 paulinebanye

Concerning making a video, I note that I may be constrained by hardware and I also lack prior video making experience

Cee-tech21 avatar Oct 18 '22 11:10 Cee-tech21

@Cee-tech21 no worries, you can assist with the notebook template. I'm working on the video.

Here's the doc with the suggested additions

paulinebanye avatar Oct 18 '22 14:10 paulinebanye

@pauline-banye, thanks for creating the docs, to have a more streamlined process, because we might want to include the changes made on the template into the guide and video.

I have also included some suggestions for the notebook template.

Malikbadmus avatar Oct 18 '22 15:10 Malikbadmus

Just a starting idea for the notebook:

https://colab.research.google.com/drive/1rCGNGYCtqJ9OQra0KDRShvv3bV4sF5fF?usp=sharing

Cee-tech21 avatar Oct 18 '22 16:10 Cee-tech21

Fantastic @Cee-tech21, @pauline-banye, and @ZakiaYahya, can we start incorporating the suggestion on docs to this notebook?

Malikbadmus avatar Oct 18 '22 18:10 Malikbadmus

@Malikbadmus yes sure. Can we do all sections together?

ZakiaYahya avatar Oct 18 '22 18:10 ZakiaYahya

@ZakiaYahya , I think we should, what do you think @ZakiaYahya, @Cee-tech21 . We can then include the link to the tutorial video created on the template.

Malikbadmus avatar Oct 18 '22 18:10 Malikbadmus

Hi @GemmaTuron !

This is a great idea. I would love to contribute to making the template better and with easier readability.

Femme-js avatar Oct 18 '22 18:10 Femme-js

@Cee-tech21 I can co-lead with you on making the template better. I have a few ideas already.

Femme-js avatar Oct 18 '22 18:10 Femme-js

@GemmaTuron can we also create a thread for the improvement of ersilia cli as well, there are a lot of errors people can report while testing the models and those can be handled in a better way, so as to give a better idea of what is the actual problem. For example: If I run ersilia card eos4b8j without fetching the model first it will give an error in the command line, but if it can just let the user know that the model has not been fetched yet or has been deleted then it can be more helpful.

muskansawa avatar Oct 18 '22 19:10 muskansawa

Hello @GemmaTuron, this is a very fantastic concept, I will like to work on the comprehensive guide.

Is anyone also interested in working with me on this?

hi @Malikbadmus I would love to offer assist

EstherIdabor avatar Oct 19 '22 00:10 EstherIdabor

@ZakiaYahya , I think we should, what do you think @ZakiaYahya, @Cee-tech21 . We can then include the link to the tutorial video created on the template.

I just had a thought, should we push the video creation till when the template is updated? It might be confusing for people to see some features on the template that aren't present in the video @ZakiaYahya @Malikbadmus @Cee-tech21 @sayantani11

paulinebanye avatar Oct 19 '22 00:10 paulinebanye

Well observed @pauline-banye I agree with you about making the video and the template concur!!! I am through with the draft template now. You can copy the template to your drive and add some modifications to make the template agree with the video

Cee-tech21 avatar Oct 19 '22 00:10 Cee-tech21

Yes please!!

paulinebanye avatar Oct 19 '22 00:10 paulinebanye

I propose that anyone who wants to should copy the draft template and also make suggestions in a copy of the template! then @pauline-banye willl integrate all suggestions into the template/video. See link below:

https://colab.research.google.com/drive/1rCGNGYCtqJ9OQra0KDRShvv3bV4sF5fF?usp=sharing#scrollTo=-Rh3-Vt9Nev9

Cee-tech21 avatar Oct 19 '22 00:10 Cee-tech21

@ZakiaYahya , I think we should, what do you think @ZakiaYahya, @Cee-tech21 . We can then include the link to the tutorial video created on the template.

I just had a thought, should we push the video creation till when the template is updated? It might be confusing for people to see some features on the template that aren't present in the video @ZakiaYahya @Malikbadmus @Cee-tech21 @sayantani11

@pauline-banye Yes that's right.

ZakiaYahya avatar Oct 19 '22 01:10 ZakiaYahya

Hi @Cee-tech21 I'm impressed at how quickly you came up with this draft. Good job!

I was running through the commands on the draft template and I came across some errors.

  • The timer code returns an error err1

  • Fetch model returns no module named h5py err2

paulinebanye avatar Oct 19 '22 01:10 paulinebanye

Update:

I imported the module h5py and It resolved the error. fix

I also added suggestions and made some changes to the draft template

@Cee-tech21 @Malikbadmus @ZakiaYahya @sayantani11 @GemmaTuron

paulinebanye avatar Oct 19 '22 02:10 paulinebanye

@pauline-banye , you did not grant us access to the notebook you shared.

Malikbadmus avatar Oct 19 '22 03:10 Malikbadmus

@pauline-banye , you did not grant us access to the notebook you shared.

Oh, I forgot about that. Granted @Malikbadmus

paulinebanye avatar Oct 19 '22 03:10 paulinebanye

@GemmaTuron I would love to work on a comprehensive guide.

@Malikbadmus @ZakiaYahya I'd like to join in on the comprehensive guide. Thanks

Zainab-ik avatar Oct 19 '22 07:10 Zainab-ik

Thank you @pauline-banye .

I feel implementing the guide into the notebook will be messy, Lets create different documentation for that.

I've made some changes to the template here

@Femme-js has some suggestions on incorporating time messages during predictions.

@ZakiaYahya, @Zainab-ik, I have started working on the Comprehensive guide, you can find the link below and edit your suggestions into it.

https://docs.google.com/document/d/1JlIVmLGa1cL_Qk3q1yS0hVfnDJlHupe4Zg5L8TBYG2I/edit?usp=sharing

Malikbadmus avatar Oct 19 '22 07:10 Malikbadmus