« SportBot » : différence entre les versions

De Wikipast
Aller à la navigation Aller à la recherche
 
(38 versions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :


Le but du SportBot est d'apporter des informations sur les résultats obtenues par certains athlètes aux Jeux-Olympiques d'hiver et d'été entre 1896 et 2014 à partir d'une dataset prise sur kaggle.
Le but du SportBot est d'apporter des informations sur les résultats obtenus par certains athlètes aux Jeux Olympiques d'hiver et d'été entre 1896 et 2014 à partir d'une dataset prise sur kaggle.
Le SportBot extrait dans un premier temps les infos prise dans la base de donnée ...
Le SportBot extrait dans un premier temps les infos prises dans la base de données et créait en conséquence une page Wikipast de l'athlète avec les infos contenues dans la base de données. De plus, le bot ajoute le nombre de médailles obtenues durant au cours d'une certaine année sur la page du pays concerné.  


==Objectifs==
==Objectifs==


* Création de pages d'athlètes ayant obtenu des médailles aux JOs.
* Création/modification de page pour chaque d'athlètes ayant obtenu une ou plusieurs médailles aux JOs.
* Ajout du lieu, de la date, du type de médaille obtenue par l'athlète.
* Ajout du lieu, de la date, du type de médaille obtenue par l'athlète.
* Ajout du nombre de médailles obtenue durant l'année X sur la page du pays concerné.
* Ajout du nombre de médailles obtenue durant chaque JO dans l’équipe olympique du pays en question.


==Implémentation et fonctionnalités==
==Implémentation et fonctionnalités==
Nous avons choisi d'implémenter le bot en 4 modules distincts:
* <code>traductor.py</code> qui s'occupe de faire le preprocessing ainsi que les traductions.
* <code>text_gen.py</code> qui s'occupe de générer toutes les lignes qui devront être insérées sur Wikipast.
* <code>wikipast.py</code> qui s'occupe de l'insertion des lignes sur wikipast.
* <code>sportbot.py</code> qui s'occupe de faire la liaison entre tous les autres modules.
=== Préprocessing du dataset ===
Afin de pouvoir lire et extraire les données de notre dataset, nous utilisons la librairie Pandas.
Le premier problème rencontré est que le dataset est en anglais et que Wikipast est en français, par conséquent nous commençons par traduire tous les sports, pays et toutes les villes en utilisant l'API du site DeepL.
De plus, certaines médailles ne sont pas encore attribuées officiellement, on a donc décidé de les supprimer du dataset.
Après cela nous effectuons une correction manuelle de certains termes qui n'ont pas été traduit comme on l'aurait voulu ( Par exemple, "Swimming" traduit en "Baignade" au lieu de natation).
La dernière étape du pre-processing est de transformer les codes de pays (CH par exemple) fournis dans le dataset par le nom effectif du pays (Suisse) (à l'aide du dictionnaire fourni avec le dataset) et en appliquant une correction manuelle pour certain pays qui n'existe pas dans le dictionnaire fourni avec le dataset.
Suite à cela, nous transformons tous les noms des athlètes en minuscules sauf les initiales qui sont en majuscules.
Comme les requêts à l'API gratuite sont limitées, une fois que toutes les traductions ont été effectué, on les sauvegarde dans un fichier sur la machine.
=== Création des lignes à insérer ===
Le but de ce module est de créer toutes les lignes qui devront être insérées dans les différentes pages sur Wikipast. L'objectif était de former un dictionnaire qui avait un mapping entre la page à modifier sur Wikipast (titre de la page) et une liste de ligne à ajouter de manière à minimiser le nombre de requêtes internet (la partie la plus lente de notre bot). Etant donné, une liste de médaille par Jeux Olympiques, le but est d'ajouter:
* Une ligne par athlète par médaille sur la page de l'athlète et sur la page de l'année des JO.
* Une ligne par pays par JO (avec un calcul cumulé des médailles pour ce pays par JO) sur la page du pays, la page de l'année des JO et sur la page de la ville qui accueillait les JO cette année-là.
Nous avons choisi de ne pas mettre une ligne par médaille pour la ville de manière à ne pas surchargé la page.
le format des lignes qui vont être ajoutées est le suivant:
* Pour un pays: [[Année]] / [[Lieu des Jo]]. Obtention de "Nombre de médailles resp or/argent/bronze" par l'[[Équipe olympique pays]] aux Jeux olympiques d'été/hiver.
* Pour un athlète: [[Année]] / [[Ville]]. Obtention de la médaille or/argent/bronze par [[Nom Prenom]] dans la discipline **discipline** pour l'épreuve **épreuve**, aux Jeux Olympiques d'été/hiver.
=== Vérification d'existence ===
Afin de ne pas créer des pages à double, nous vérifions dans un premier temps si il n'existe pas déjà la page que nous souhaitons créer. Dans les cas où elle est inexistante, nous l'a créons simplement en y ajoutant les entrées souhaitées. Dans le cas où la page existe déjà, nous appliquons une autre vérification pour voir si la page est vide. Si la page est vide, nous écrivons juste les nouvelles entrées (préalablement trié par ordre chronologique) sans passer par l'algorithme de tri. Dans le cas où il existe déjà des entrées sur la page, nous utilisons l'algorithme de tri chronologique qui vient lire les entrées déjà existantes sur la page puis place nos nouvelles entrées de manière chronologique.
===Tri automatique croissant par date===
Les données sont triées par ordre croissant de date, un algorithme (sort_year) s'occupe de réordonner les entrées. L'algorithme consiste à séparer le texte de la page par ligne et de détecter les dates des événements déjà existants. Ensuite, on parcourt la liste d'années pour détecter où l'insertion se fait (ligne précédant l'endroit où l'on veut insérer la donnée). Enfin, on modifie l'ancien texte de la page qu'en insérant les nouvelles données au bon endroit dans l'ancien texte.
== Utilisation du bot ==
Notre bot est séparé en différents modules et le module central est <code>sportbot.py</code>, il prend les paramètres suivants en entrée pour fonctionner correctement:
* <code>--input-file</code> le fichier qu'il faut utiliser
* <code>--jo-type</code> qui doit valoir <code>summer</code> ou <code>winter</code> et qui sera utilisé pour formatter les lignes qui seront insérées dans Wikipast
* (optionel) <code>--preprocessing</code> qui vaut <code>1</code> si le pre-processing doit être fait et <code>0</code> sinon.
* (optionel) <code>--translate</code> qui vaut <code>1</code> si le pre-processing doit également faire la traduction des termes et <code>0</code> autrement.
* (optionel) <code>--output-file-preprocessing</code> si on veut donner un nom précis pour le fichier de sortie du pre-processing.
Un exemple de commande pour lancer le bot est le suivant:
<code>python3 sportbot.py --input-file medals.csv --jo-type summer --preprocessing 0 --translate 0</code>
A noter que le fait de mettre <code>--preprocessing</code> et <code>--translate</code> à 0 est équivalent à ne pas les spécifier du tout.


==Performances==
==Performances==
===Minimisation requête internet ===
Dans notre algorithme, les lignes de codes demandant le plus de temps sont les requêtes internet (lecture et écriture sur wikipast). Afin de minimiser ce nombre de requêtes dans le cas où nous devons écrire plusieurs lignes sur une même page nous copions dans un premier temps tout le texte de la page. Puis nous cherchons où placer nos entrées dans cette copie local de la page au lieu de faire une requête internet à chaque fois. Pour finir, nous insérons donc toute nos entrées qui vont sur la même page en une seule requête internet. Cela à l'avantage de faire uniquement deux requêtes internet pour un nombre potentiellement très grande de ligne à ajouté. Dans le cas où l'on ajouterai ligne par ligne nos entrées sur wikipast, nous aurions besoin de faire autant de requêtes que d'entrée, ce qui serai très couteux en temps.
La traduction via une API est également gourmande en ressource et prends beaucoup de temps. En laissant la possibilité lors de l'utilisation de traduire une seule fois le dataset et de stocker en fichier .csv le résultat, le bot est beaucoup plus rapide.
===Minimisation du preprocessing ===
Nous avons laisser la possibilité à l'utilisateur de preprocessed les données ou non pour réduire le temps d'execution executer le preprocessing uniquement en cas de besoin.


==Limitations==
==Limitations==


==Exemples==  
===Traduction===
Le système de traduction utilisé est limité en version gratuite [https://www.deepl.com/pro?/pro?cta=header-prices=header-pro] et le bot ne fonctionne donc pas avec des dataset avec trop de donnée.
Les traductions de certains sport sont parfois mauvaise, par exemple "swimming" qui a été traduit en "baignade" alors qu'il fallait traduire en "natation". Nous avons donc du ajouter un module de correction de traduction pour les mauvaises traductions.
 
===Versatilité du code===
Notre bot n'est pas adapté si le dataset change de forme et notre bot devrait être adapté. En résumé, nous avons un bot qui manque de versatilité.
 
==Exemples==
 
Par exemples, la page [[1896]] aura plusieurs nouvelles entrée comme:
* [[1896]] / [[Athènes]]. Obtention de la médaille d'or par [[ Aristidis Konstantinidis]] dans la discipline route cycliste pour l'épreuve course sur route individuelle aux Jeux Olympiques d'été.[https://www.kaggle.com/the-guardian/olympic-games]
* [[1896]] / [[Athènes]]. Obtention de 2 médaille(s) d'or, 2 médaille(s) d'argent, 2 médaille(s) de bronze par la nation [[Equipe mixte aux Jeux Olympiques]] aux Jeux olympiques d'été.[https://www.kaggle.com/the-guardian/olympic-games]
Le premier exemple est un ajout d'une personne et le second un ajout du nombre de médaille pour une nation.


==Code==
==Code==
Ligne 21 : Ligne 101 :
Le code source est disponible sur ce lien [https://github.com/Palmisano-Enzo/sportbot]
Le code source est disponible sur ce lien [https://github.com/Palmisano-Enzo/sportbot]


==DATASET==
==Dataset==


La data prise provient du site kaggle et plus précisément de la dataset suivante [https://www.kaggle.com/the-guardian/olympic-games]
Le dataset que nous utilisons provient du site kaggle. Plus précisément, nous utilisons le dataset suivant [https://www.kaggle.com/the-guardian/olympic-games]

Dernière version du 31 mai 2021 à 05:50

Le but du SportBot est d'apporter des informations sur les résultats obtenus par certains athlètes aux Jeux Olympiques d'hiver et d'été entre 1896 et 2014 à partir d'une dataset prise sur kaggle. Le SportBot extrait dans un premier temps les infos prises dans la base de données et créait en conséquence une page Wikipast de l'athlète avec les infos contenues dans la base de données. De plus, le bot ajoute le nombre de médailles obtenues durant au cours d'une certaine année sur la page du pays concerné.

Objectifs

  • Création/modification de page pour chaque d'athlètes ayant obtenu une ou plusieurs médailles aux JOs.
  • Ajout du lieu, de la date, du type de médaille obtenue par l'athlète.
  • Ajout du nombre de médailles obtenue durant chaque JO dans l’équipe olympique du pays en question.

Implémentation et fonctionnalités

Nous avons choisi d'implémenter le bot en 4 modules distincts:

  • traductor.py qui s'occupe de faire le preprocessing ainsi que les traductions.
  • text_gen.py qui s'occupe de générer toutes les lignes qui devront être insérées sur Wikipast.
  • wikipast.py qui s'occupe de l'insertion des lignes sur wikipast.
  • sportbot.py qui s'occupe de faire la liaison entre tous les autres modules.

Préprocessing du dataset

Afin de pouvoir lire et extraire les données de notre dataset, nous utilisons la librairie Pandas.

Le premier problème rencontré est que le dataset est en anglais et que Wikipast est en français, par conséquent nous commençons par traduire tous les sports, pays et toutes les villes en utilisant l'API du site DeepL.

De plus, certaines médailles ne sont pas encore attribuées officiellement, on a donc décidé de les supprimer du dataset.

Après cela nous effectuons une correction manuelle de certains termes qui n'ont pas été traduit comme on l'aurait voulu ( Par exemple, "Swimming" traduit en "Baignade" au lieu de natation).

La dernière étape du pre-processing est de transformer les codes de pays (CH par exemple) fournis dans le dataset par le nom effectif du pays (Suisse) (à l'aide du dictionnaire fourni avec le dataset) et en appliquant une correction manuelle pour certain pays qui n'existe pas dans le dictionnaire fourni avec le dataset.

Suite à cela, nous transformons tous les noms des athlètes en minuscules sauf les initiales qui sont en majuscules.

Comme les requêts à l'API gratuite sont limitées, une fois que toutes les traductions ont été effectué, on les sauvegarde dans un fichier sur la machine.

Création des lignes à insérer

Le but de ce module est de créer toutes les lignes qui devront être insérées dans les différentes pages sur Wikipast. L'objectif était de former un dictionnaire qui avait un mapping entre la page à modifier sur Wikipast (titre de la page) et une liste de ligne à ajouter de manière à minimiser le nombre de requêtes internet (la partie la plus lente de notre bot). Etant donné, une liste de médaille par Jeux Olympiques, le but est d'ajouter:

  • Une ligne par athlète par médaille sur la page de l'athlète et sur la page de l'année des JO.
  • Une ligne par pays par JO (avec un calcul cumulé des médailles pour ce pays par JO) sur la page du pays, la page de l'année des JO et sur la page de la ville qui accueillait les JO cette année-là.

Nous avons choisi de ne pas mettre une ligne par médaille pour la ville de manière à ne pas surchargé la page.

le format des lignes qui vont être ajoutées est le suivant:

  • Pour un athlète: Année / Ville. Obtention de la médaille or/argent/bronze par Nom Prenom dans la discipline **discipline** pour l'épreuve **épreuve**, aux Jeux Olympiques d'été/hiver.

Vérification d'existence

Afin de ne pas créer des pages à double, nous vérifions dans un premier temps si il n'existe pas déjà la page que nous souhaitons créer. Dans les cas où elle est inexistante, nous l'a créons simplement en y ajoutant les entrées souhaitées. Dans le cas où la page existe déjà, nous appliquons une autre vérification pour voir si la page est vide. Si la page est vide, nous écrivons juste les nouvelles entrées (préalablement trié par ordre chronologique) sans passer par l'algorithme de tri. Dans le cas où il existe déjà des entrées sur la page, nous utilisons l'algorithme de tri chronologique qui vient lire les entrées déjà existantes sur la page puis place nos nouvelles entrées de manière chronologique.

Tri automatique croissant par date

Les données sont triées par ordre croissant de date, un algorithme (sort_year) s'occupe de réordonner les entrées. L'algorithme consiste à séparer le texte de la page par ligne et de détecter les dates des événements déjà existants. Ensuite, on parcourt la liste d'années pour détecter où l'insertion se fait (ligne précédant l'endroit où l'on veut insérer la donnée). Enfin, on modifie l'ancien texte de la page qu'en insérant les nouvelles données au bon endroit dans l'ancien texte.


Utilisation du bot

Notre bot est séparé en différents modules et le module central est sportbot.py, il prend les paramètres suivants en entrée pour fonctionner correctement:

  • --input-file le fichier qu'il faut utiliser
  • --jo-type qui doit valoir summer ou winter et qui sera utilisé pour formatter les lignes qui seront insérées dans Wikipast
  • (optionel) --preprocessing qui vaut 1 si le pre-processing doit être fait et 0 sinon.
  • (optionel) --translate qui vaut 1 si le pre-processing doit également faire la traduction des termes et 0 autrement.
  • (optionel) --output-file-preprocessing si on veut donner un nom précis pour le fichier de sortie du pre-processing.

Un exemple de commande pour lancer le bot est le suivant:

python3 sportbot.py --input-file medals.csv --jo-type summer --preprocessing 0 --translate 0

A noter que le fait de mettre --preprocessing et --translate à 0 est équivalent à ne pas les spécifier du tout.

Performances

Minimisation requête internet

Dans notre algorithme, les lignes de codes demandant le plus de temps sont les requêtes internet (lecture et écriture sur wikipast). Afin de minimiser ce nombre de requêtes dans le cas où nous devons écrire plusieurs lignes sur une même page nous copions dans un premier temps tout le texte de la page. Puis nous cherchons où placer nos entrées dans cette copie local de la page au lieu de faire une requête internet à chaque fois. Pour finir, nous insérons donc toute nos entrées qui vont sur la même page en une seule requête internet. Cela à l'avantage de faire uniquement deux requêtes internet pour un nombre potentiellement très grande de ligne à ajouté. Dans le cas où l'on ajouterai ligne par ligne nos entrées sur wikipast, nous aurions besoin de faire autant de requêtes que d'entrée, ce qui serai très couteux en temps. La traduction via une API est également gourmande en ressource et prends beaucoup de temps. En laissant la possibilité lors de l'utilisation de traduire une seule fois le dataset et de stocker en fichier .csv le résultat, le bot est beaucoup plus rapide.

Minimisation du preprocessing

Nous avons laisser la possibilité à l'utilisateur de preprocessed les données ou non pour réduire le temps d'execution executer le preprocessing uniquement en cas de besoin.

Limitations

Traduction

Le système de traduction utilisé est limité en version gratuite [1] et le bot ne fonctionne donc pas avec des dataset avec trop de donnée. Les traductions de certains sport sont parfois mauvaise, par exemple "swimming" qui a été traduit en "baignade" alors qu'il fallait traduire en "natation". Nous avons donc du ajouter un module de correction de traduction pour les mauvaises traductions.

Versatilité du code

Notre bot n'est pas adapté si le dataset change de forme et notre bot devrait être adapté. En résumé, nous avons un bot qui manque de versatilité.

Exemples

Par exemples, la page 1896 aura plusieurs nouvelles entrée comme:

Le premier exemple est un ajout d'une personne et le second un ajout du nombre de médaille pour une nation.

Code

Le code source est disponible sur ce lien [4]

Dataset

Le dataset que nous utilisons provient du site kaggle. Plus précisément, nous utilisons le dataset suivant [5]