From af6a512da9bd56528838fac587603a2c4a792a78 Mon Sep 17 00:00:00 2001 From: eslopfer Date: Thu, 22 Dec 2022 16:19:24 +0000 Subject: [PATCH] docs(visualizations): fix audits format --- subjects/ai/visualizations/audit/README.md | 78 ++++++++++------------ 1 file changed, 37 insertions(+), 41 deletions(-) diff --git a/subjects/ai/visualizations/audit/README.md b/subjects/ai/visualizations/audit/README.md index b1d8ea0d..985da705 100644 --- a/subjects/ai/visualizations/audit/README.md +++ b/subjects/ai/visualizations/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercice is validated is all questions of the exercice are validated +##### The exercise is validated if all questions of the exercise are validated ##### Activate the virtual environment. If you used `conda` run `conda activate your_env` @@ -8,7 +8,7 @@ ###### Does it print `Python 3.x`? x >= 8 -##### Does `import jupyter`, `import numpy`, `import pandas`, `matplotlib` and `plotly` run without any error ? +##### Do `import jupyter`, `import numpy`, `import pandas`, `matplotlib` and `plotly` run without any error ? --- @@ -16,25 +16,23 @@ #### Exercise 1: Pandas plot 1 -##### The exercice is validated is all questions of the exercice are validated +##### The exercise is validated is all questions of the exercise are validated -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. +###### For question 1, does the plot reproduce the plot in the image and respect those criteria? -###### Does it have a the title ? +###### Does it have a title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? ![alt text][logo_ex6] [logo_ex6]: ../w1day03_ex6_plot1.png "Time series ex6" -##### The solution of question 2 is accepted if the plot reproduces the plot in the image by using `plotly.graph_objects` and respect those criteria. +###### For question 2, does the plot reproduce the plot in the image by using `plotly.graph_objects` and respect those criteria? -2.This question is validated if the plot is in the image is reproduced using `plotly.graph_objects` given those criteria: +###### Does it have a title? -###### Does it have a the title ? - -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? ![alt text][logo_ex6] @@ -46,11 +44,11 @@ #### Exercise 2: Pandas plot 2 -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect the following criteria. It is important to observe that the older people are, the the more children they have. +###### For question 1, does the plot reproduce the plot in the image and respect the following criteria? It is important to observe that the older people are, the the more children they have. -###### Does it have a the title ? +###### Does it have a title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? ![alt text][logo_ex2] @@ -62,17 +60,17 @@ #### Exercise 3: Matplotlib 1 -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. +###### For question 1, does the plot reproduce the plot in the image and respect those criteria? -###### Does it have a the title ? +###### Does it have a title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? -###### Are the x-axis and y-axis limited to [1,8] ? +###### Are the x-axis and y-axis limited to [1,8]? -###### Is the line a red dashdot line with a width of 3 ? +###### Is the line a red dashdot line with a width of 3? -###### Are the circles blue circles with a size of 12 ? +###### Are the circles blue circles with a size of 12? ![alt text][logo_ex3] @@ -84,15 +82,15 @@ #### Exercise 4: Matplotlib 2 -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. +###### For question 1, does the plot reproduce the plot in the image and respect those criteria? -###### Does it have a the title ? +###### Does it have a title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? -###### Is the left data black ? +###### Is the left data black? -###### Is the right data red ? +###### Is the right data red? ![alt text][logo_ex4] @@ -106,17 +104,17 @@ https://matplotlib.org/gallery/api/two_scales.html #### Exercise 5: Matplotlib subplots -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. +###### For question 1, does the plot reproduces the plot in the image and respect those criteria? ###### Does it contain 6 subplots (2 rows, 3 columns)? ###### Does it have space between plots (`hspace=0.5` and `wspace=0.5`)? -###### Do all subplots contain a title: `Title i` ? +###### Do all subplots contain a title: `Title i`? -###### Do all subplots contain a text `(2,3,i)` centered at `(0.5, 0.5)`? _Hint_: check the parameter `ha` of `text` +###### Do all subplots contain a text `(2,3,i)` centered at `(0.5, 0.5)`? _Hint_: check the parameter `ha` of `text`. -###### Have all subplots been created in a for loop ? +###### Have all subplots been created in a for loop? ![alt text][logo_ex5] @@ -128,25 +126,23 @@ https://matplotlib.org/gallery/api/two_scales.html #### Exercise 6: Plotly 1 -##### The exercice is validated is all questions of the exercice are validated +##### The exercise is validated if all questions of the exercise are validated -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. +###### For question 1, does the plot reproduce the plot in the image and respect those criteria? -###### Does it have a the title ? +###### Does it have the title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? ![alt text][logo_ex6] [logo_ex6]: ../w1day03_ex6_plot1.png "Time series ex6" -##### The solution of question 2 is accepted if the plot reproduces the plot in the image by using `plotly.graph_objects` and respect those criteria. - -2.This question is validated if the plot is in the image is reproduced using `plotly.graph_objects` given those criteria: +###### For question 2, does the plot reproduce the plot in the image by using `plotly.graph_objects` and respect those criteria? -###### Does it have a the title ? +###### Does it have a title? -###### Does it have a name on x-axis and y-axis ? +###### Does it have a name on x-axis and y-axis? ![alt text][logo_ex6] @@ -158,11 +154,11 @@ https://matplotlib.org/gallery/api/two_scales.html #### Exercise 7: Plotly Box plots -##### The solution of question 1 is accepted if the plot reproduces the plot in the image and respect those criteria. The code below shows a solution. +###### For question 1, does the plot reproduce the plot in the image and respect those criteria? The code below shows a solution. -###### Does it have a the title ? +###### Does it have a title ? -###### Does it have a legend ? +###### Does it have a legend? ![alt text][logo_ex7]