readme

Author: Wonters

.idea/sentimental_analyses.iml

@@ -1,4 +1,4 @@
-FROM python:3.10-slim
+FROM python:3.11.11-slim
 RUN apt-get update && apt-get install -y procps git
 LABEL authors="shift"
 WORKDIR /app
@@ -11,4 +11,4 @@ COPY supervisord.conf .
 EXPOSE 5000
 EXPOSE 5001
 
-ENTRYPOINT ["./entrypoint.sh"]
+ENTRYPOINT ["./entrypoint.sh"]

Dockerfile

@@ -1,5 +1,22 @@
 # Sentimental analyses with MLFLOW and models Wrappers
 
+[![version](https://img.shields.io/badge/version-1.0.0-green.svg)](https://semver.org)
+
+## Table of content
+- [Overview](#overview)
+- [Architecture](#architecture)
+- [Install](#install)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [Production](#production)
+- [Monitoring](#monitoring)
+- [Api](#api)
+- [License](#license)
+- [Author](#author)
+- [Thanks](#thanks)
+
+## Overview
+
 Tweet sentimental analyses with different models.
 
 Four wrapper of models:
@@ -15,18 +32,7 @@ MLFlow is used to list all experiments and easily commpare results for several d
 Optuna is used to optimise parameters. It run a set of experiments with a variation of parameters and select the best configuration
 maximising the accuracy.
 
-
-
-The app is dockerised and can be installed launching the command
-```bash
-docker compose up 
-```
-or to run in background
-```bash
-docker compose up -d 
-```
-
-## Access and architecture
+## Architecture
 The application contains alerting system and monitoring on grafana on port 3000
 APP      PORT
 MLFLOW   5001
@@ -42,15 +48,36 @@ Prometheus send metrics as the number of prediction running.
 An alert is send by mail when number of predictions in concurrency are up to 5.
 An alert is send when the result of the prediction is too bad, probability < 0.5.
 
-## Installation in dev  
-# Install uv (Rust package to fastly install package)
+
+## Install
+
+The app is dockerised and can be installed launching the command
+```bash
+docker compose up 
+```
+or to run in background
+```bash
+docker compose up -d 
+```
+
+
+## Contributing  
+#### Install uv (Rust package to fastly install package)
 ```bash
 curl -Ls https://astral.sh/uv/install.sh | bash
 export PATH="$HOME/.cargo/bin:$PATH"
 ```
+#### Source the code in the container
+Modify the docker-compose.yaml to add the source code as volume
+```bash
+volumes:
+  - ./src:/app/src/
+  - ./mlruns:/app/mlruns/
+```
 
-## OVH Train with AI train 
+## Usage
 
+### OVH Train with AI train 
 Create an object storage on OVH managed with ovhai cli
 The secret key is obtain clicking on the user object storage line 'access secret key'
 ```bash
@@ -65,7 +92,7 @@ Credentials are stored in ~/.config/ovhai/context.json
 uv pip install boto3 awscli ovhai
 ```
 
-## Run on multi GPU
+### Run on multi GPU
 DEBUG
 ```bash
 export TORCH_DISTRIBUTED_DEBUG=DETAIL
@@ -74,16 +101,36 @@ export TORCH_DISTRIBUTED_DEBUG=DETAIL
 python -m torch.distributed.run --nproc_per_node=2 train.py
 ```
 
-## Tests
+### Tests
 ```bash
 pytest src/tests
 ```
 
-## Launch a test to verify the prection from the API
+### Launch a test to verify the prection from the API
 Go on 127.0.0.1:5000, tap your tweet and click on predict button
 
-Par requête http
+
+## Production
+An exemple deployment is available on https://tweetsentiment.shift.python.software.fr
+
+## Monitoring
+Add alert and monitoring and dashboard on grafana on your local instance
+and save them in grafana folder. 
+Reload grafana and they will be available on http://localhost:3000 as provisionning templates
+
+## Api
+You can contact the api example 
+or change the url on the script predict_client.py to test your instance
 ```bash
 export $(cat .env | xargs)
-python post.py 
+python predict_client.py 
 ```
+## License
+
+MIT License
+
+## Author
+Shift python software
+
+## Thanks
+Thanks to all contributors

README.md

@@ -47,7 +47,7 @@ <h2 class="text-justify m-2"> Bienvenue Sur TweetSentimentPredict </h2>
         body: JSON.stringify(payload)
       }).then(res => res.json()).then(res => {
         button.disabled = true;
-        ws = new WebSocket("ws://127.0.0.1:5000/ws/" + res.task_id)
+        ws = new WebSocket(`ws://${window.location.host}/ws/` + res.task_id)
         ws.onmessage = (event) => {
           const element = document.getElementById("result")
           const payload = JSON.parse(event.data)