read me file

readme.md

@@ -0,0 +1,42 @@
+# Project : Natural Language Processing
+
+## Description
+
+This repository contains the ressources to start the NLP-related live project you shoud take. The below assignments will introduce you in Unstructured data exploitation, especially Natural Language Processing data, using ML. 
+
+This project is about creating an app for a sentiment anlysis on COVID 19 tweets.
+
+## Assignments
+Find the list of assignments below:
+- [Zindi NLP Challenge](/zindi_challenge/)
+
+## Setup
+Install the required packages to be able to run the evaluation locally.
+
+You need to have [`Python3`](https://www.python.org/) on your system. Then you can clone this repo and being at the repo's root (`root :: repo_name> ...`)  follow the steps below:
+
+- Windows:
+        
+        python -m venv venv; venv\Scripts\activate; python -m pip install -q --upgrade pip; python -m pip install -qr requirements.txt  
+
+- Linux & MacOs:
+        
+        python3 -m venv venv; source venv/bin/activate; python -m pip install -q --upgrade pip; python -m pip install -qr requirements.txt  
+
+The both long command-lines have a same structure, they pipe multiple commands using the symbol **;** but you may manually execute them one after another.
+
+1. **Create the Python's virtual environment** that isolates the required libraries of the project to avoid conflicts;
+2. **Activate the Python's virtual environment** so that the Python kernel & libraries will be those of the isolated environment;
+3. **Upgrade Pip, the installed libraries/packages manager** to have the up-to-date version that will work correctly;
+4. **Install the required libraries/packages** listed in the `requirements.txt` file so that it will be allow to import them into the python's scripts and notebooks without any issue.
+
+**NB:** For MacOs users, please install `Xcode` if you have an issue.
+
+## Ressources
+1. [Quick intro to NLP](https://www.youtube.com/watch?v=CMrHM8a3hqw)
+1. [Getting Started With Hugging Face in 15 Minutes](https://www.youtube.com/watch?v=QEaBAZQCtwE)
+1. [Fine-tuning a Neural Network explained](https://www.youtube.com/watch?v=5T-iXNNiwIs)
+1. [Fine-Tuning-DistilBert - Hugging Face Transformer for Poem Sentiment Prediction | NLP](https://www.youtube.com/watch?v=zcW2HouIIQg)
+1. [Introduction to NLP: Playlist](https://www.youtube.com/playlist?list=PLM8wYQRetTxCCURc1zaoxo9pTsoov3ipY)
+<!-- 1. [](https://www.youtube.com/)
+1. [](https://www.youtube.com/) -->