diff --git a/docs/cleaning.md b/docs/cleaning.md new file mode 100644 index 0000000..3ef5c79 --- /dev/null +++ b/docs/cleaning.md @@ -0,0 +1,17 @@ +# Cleaning + +## Sommaire +[TOC] + +--- + +## Classe `Cleaning` +::: src.cleaning.Cleaning + options: + heading_level: 3 + members: + - __init__ + - getVins + - drop_empty_appellation + - fill_missing_scores + - encode_appellation diff --git a/docs/index.md b/docs/index.md index 8e44418..9a49d3d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,3 @@ -# Millesima \ No newline at end of file +# Millesima + +L’objectif de ce projet est d’étudier, en utilisant des méthodes d’apprentissage automatique, l’impact de différents critères (notes des critiques, appelation) sur le prix d’un vin. Pour ce faire, on s’appuiera sur le site Millesima (https://www.millesima.fr/), qui a l’avantage de ne pas posséder de protection contre les bots. Par respect pour l’hébergeur du site, on veillera à limiter au maximum le nombre de requêtes. En particulier, on s’assurera d’avoir un code fonctionnel avant de scraper l’intégralité du site, pour éviter les répétitions. \ No newline at end of file diff --git a/docs/scraper.md b/docs/scraper.md index 1141949..206672d 100644 --- a/docs/scraper.md +++ b/docs/scraper.md @@ -1,3 +1,31 @@ # Scraper -::: scraper.Scraper \ No newline at end of file +## Sommaire +[TOC] + +--- + +## Classe `Scraper` +::: scraper.Scraper + options: + members: + - __init__ + - getvins + - getjsondata + - getresponse + - getsoup + heading_level: 4 + +## Classe `_ScraperData` +::: scraper._ScraperData + options: + members: + - __init__ + - getdata + - appellation + - parker + - robinson + - suckling + - prix + - informations + heading_level: 4 \ No newline at end of file diff --git a/docs/scraperdata.md b/docs/scraperdata.md deleted file mode 100644 index 9197c05..0000000 --- a/docs/scraperdata.md +++ /dev/null @@ -1,4 +0,0 @@ - -# _ScraperData - -::: scraper._ScraperData \ No newline at end of file