# Outreachy Summer 2022

### Follow the Topic of the Week

Every **Monday by 9 pm CET**, one person of the team will suggest one topic and the rest of us will prioritize model search about this topic during the week. Topics can be related to a task of biomedical relevance, or to a particular family of algorithms. Valid topics could be:

By biomedical relevance:

* Antimalarial activity prediction
* Broad spectrum antibiotic activity prediction
* Drug toxicity prediction
* Synthetic accessibility of compounds

By algorithmic relevance:

* Graph neural networks
* Reinforcement learning methods
* Chemistry language transformer models

{% hint style="danger" %}
Please note that Topics of the Week should be taken as a **soft guideline**. Discovery and selection of model **should not be blocked** by the existence of the Topic of the Week. If you find a model that is interesting but it is unrelated to the Topic of the Week, feel free to select it and work on it. It is still a valid choice!
{% endhint %}

#### Announcing the Topic of the Week

In the Slack `#internships` channel, one person (for example **@Miquel**) will write a message like this:

:calendar: **@channel** This is the topic of the week!\
:robot: Topic: Antimalarial activity prediction\
:thinking: Why? We are currently working with [Medicines for Malaria Venture](https://mmv.org) and they have asked for predictions on some antimalarial candidates.\
:track\_next: Next: **@Gemma**

In this case, **@Miquel** should pin :pushpin: the message so that everybody can find it easily during the week.

It would be great if the rest of the **@channel** can make comments, ask questions, or give feedback about the topic choice. Or even just confirm that you've read the message (:raised\_hands:,:thumbsup:,:heart:,...)

{% hint style="warning" %}
Note that **@Miquel** has nominated **@Gemma**. So **@Gemma** will be responsible for selecting a model next week. If you are eager to suggest a topic, simply contact the current responsible person so that they can nominate you :wink:.
{% endhint %}

{% hint style="info" %}
The :thinking: **Why?** bullet point should be short, and can be anything, really. "*I haven't found any model of this kind in the hub"* is a perfectly valid statement, as is *"I want to learn about this family of models",* or *"I've read somewhere that there is no drug against this pathogen"*, etc.
{% endhint %}

### Notify and keep track of models

It is important that you communicate your research to the rest of the team. We suggest the following three steps:

#### Ersilia Slack `#literature`channel

First, write a quick note in the **Ersilia Slack** `#literature` channel. Simply copy the link to the publication as soon as you discover the model, or even a link to a tweet. Before the link, add the :robot: emoji so that we know it is about a model. For example: :robot: *Compound price prediction with deep learning!* [*\[link\]*](https://chemrxiv.org/engage/chemrxiv/article-details/621cf4bace899be245a72621)

{% hint style="info" %}
The Slack `#literature` channel contains models :robot: and much more. We encourage you to check this channel regularly and be active in it! This is the best way to share our collective knowledge and avoid duplication of efforts. Naturally, this channel will not be very structured, and we feel it shouldn't be. Rather, it should be a space to quickly share findings and find inspiration for your research.
{% endhint %}

#### Ersilia Model Hub Spreadsheet

Once you've posted the model in the `#literature` channel, read about it in more detail and try to figure out if code is available. Then, add the model as a new entry in the [**Ersilia Model Hub Spreadsheet**](https://docs.google.com/spreadsheets/d/1TQdei8kkF6zMGyDn0km0qmjZb6p-PM9gsBnSWg3637s/edit?usp=sharing). Please **request edit rights** to **@Gemma** if you don't have them.

In the Spreadsheet, you will find two sheets:

* **Hub:** Contains complete documentation about the models, including an Ersilia Open Source identifier (e.g. `eos4e40`), a slug (e.g. `chemprop-antibiotic`) and a status (e.g. *Done*).
* **Raw List:** Contains a backlog of models that could be of interest to Ersilia. This sheet contains minimal information about the models. There is an *Approved* and a *Selected* tickbox. *Approved* means that Ersilia is willing to incorporate this model. *Selected* means that someone is already working on the model or the model has been successfully incorporated in the Ersilia Model Hub.

You should **start by the Raw List sheet**. You are always free to add models there (relevant to the [Topic of the Week](#follow-the-topic-of-the-week) or not). **@Miquel** is responsible for curating this list and approving the models, he will use the Slack `#internships` channel to ask questions or discuss the relevance of the model before approving them.

Start by adding your model in the Raw List sheet and wait for approval. As soon as the model has been approved, you are ready to move forward. **Please tick the *****Selected***** column** so that nobody else picks your model of interest.

Now you are ready to start **filling the Hub sheet**. Fill in as much information as possible, and if something is missing make sure you provide relevant links and enough information for others to understand what the model is about.

Please write *To do*, *In progress* or *Done* in the *Status* column:

* *To do* means that you have filled the information but you have not started the model incorporation per se. In other words, you have not started to work on the coding part yet.
* *In progress* means that you are already working on the code.
* *Done* means that the model has been successfully incorporated in the Ersilia Model Hub.

Try to provide a *Title* and a *Description*, and perhaps suggest a *Slug.* The Ersilia Open Source identifiers are already predefined, so no need to worry about it. Don't forget to write your name in the *Contributor* column.

{% hint style="info" %}
**@Gemma** and **@Ife** are the maintainers of the Spreadsheet. Please reach out to them if you have questions or suggestions.
{% endhint %}

{% hint style="success" %}
The goal of the *Contributor* colum is, simply, to know who is the person of reference for each model. Some models are more difficult to add than others, so **you should not be stressed** about the number of models that you contribute. Ersilia is a safe and collaborative space, we do not monitor this kind of metrics :hugging:.
{% endhint %}

#### Ersilia Model Hub AirTable

For now, **@Miquel** will be responsible for **curating** the models listed in the Spreadsheet. He will reach out to you if he has questions or needs more information about the model. He will copy the information from the Spreadsheet to an [AirTable Base](https://airtable.com/shrUcrUnd7jB9ChZV). This Base is accessed programmatically by the [Ersilia CLI](https://github.com/ersilia-os) and our (provisional) [hub interface](https://ersilia.io/model-hub).

{% hint style="success" %}
**You don't have to worry** about the AirTable base for now. This database is fully managed by **@Miquel**.
{% endhint %}

### Start coding! :rocket:

As soon as you feel ready to start coding, you should change the *Status* in the Spreadsheet Hub sheet from *To do* to *In progress*. Please go to the next page to learn more about how to [Incorporate models to the hub](https://ersilia.gitbook.io/ersilia-book/contributors/internships/broken-reference).

{% content-ref url="broken-reference" %}
[Broken link](https://ersilia.gitbook.io/ersilia-book/contributors/internships/broken-reference)
{% endcontent-ref %}

## TL;DR

In brief, this is a suggested routine that you can follow:

1. Check the [Topic of the Week](#follow-the-topic-of-the-week).
2. [Search models](#know-where-to-find-models-and-get-inspiration) related to the topic.
3. [Post your findings](#ersilia-slack-literaturechannel) in the `#literature` channel.
4. Choose one or few models and [add them in the backlog](#ersilia-model-hub-spreadsheet) (**Raw List** sheet of the [Ersilia Model Hub Spreadsheet](https://docs.google.com/spreadsheets/d/1TQdei8kkF6zMGyDn0km0qmjZb6p-PM9gsBnSWg3637s/edit?usp=sharing)).
5. Wait for approval.
6. Select an approved model.
7. Move to the **Hub** sheet of the Spreadsheet and [fill in as much information as you can](#ersilia-model-hub-spreadsheet). For now, set the *Status* to *To do*.
8. When you are ready to [start coding](https://ersilia.gitbook.io/ersilia-book/contributors/internships/broken-reference), change the *Status* to *In progress*.
9. When the model is successfully added, change the *Status* to *Done*! :tada: