From f8fae31cf027f096c1653283094ddbf1b16c3bde Mon Sep 17 00:00:00 2001 From: eslopfer Date: Wed, 28 Dec 2022 08:17:15 +0000 Subject: [PATCH] docs(ai-audits): fix format errors, rephrase, and typos --- subjects/ai/classification/audit/README.md | 6 +++--- subjects/ai/credit-scoring/audit/README.md | 2 +- subjects/ai/data-wrangling/audit/README.md | 2 +- subjects/ai/keras-2/audit/README.md | 2 +- subjects/ai/keras/audit/README.md | 2 +- subjects/ai/linear-regression/audit/README.md | 2 +- subjects/ai/model-selection/audit/README.md | 4 ++-- subjects/ai/neural-networks/audit/README.md | 2 +- subjects/ai/nlp-spacy/audit/README.md | 2 +- subjects/ai/pipeline/audit/README.md | 2 +- subjects/ai/visualizations/audit/README.md | 4 ++-- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/subjects/ai/classification/audit/README.md b/subjects/ai/classification/audit/README.md index 7011d341c..9ed24a48d 100644 --- a/subjects/ai/classification/audit/README.md +++ b/subjects/ai/classification/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercise is validated is all questions of the exercise 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` @@ -50,7 +50,7 @@ Score: #### Exercise 3: Decision boundary -##### The exercise is validated is all questions of the exercise are validated +##### The exercise is validated if all questions of the exercise are validated ###### Does the outputted plot for question 1 look like this? @@ -130,7 +130,7 @@ y_test: #### Exercise 5: Breast Cancer prediction -###### The exercise is validated is all questions of the exercise are validated +###### The exercise is validated if all questions of the exercise are validated ###### Is the proportion of class `Benign` 0.6552217453505007 for question 1? It means that if you always predict `Benign` your accuracy would be 66%. diff --git a/subjects/ai/credit-scoring/audit/README.md b/subjects/ai/credit-scoring/audit/README.md index 2f2db203b..0c363cdd8 100644 --- a/subjects/ai/credit-scoring/audit/README.md +++ b/subjects/ai/credit-scoring/audit/README.md @@ -84,4 +84,4 @@ This [article](https://medium.com/thecyphy/home-credit-default-risk-part-2-84b58 ###### Are the 3 clients selected as expected? 2 clients from the train set (1 on which the model is correct and 1 on which the model's wrong) and 1 client from the test set. -###### SHAP values on predictions are computed for the 3 clients. The force plot shows what variables contributes the most to the score. **Check that the score outputted by the force plot corresponds to the one outputted by the model.** +###### SHAP values on predictions are computed for the 3 clients. The force plot shows what variables contributes the most to the score. Does the score outputted by the force plot correspond to the one outputted by the model? diff --git a/subjects/ai/data-wrangling/audit/README.md b/subjects/ai/data-wrangling/audit/README.md index 65a2d1edc..b7812e416 100644 --- a/subjects/ai/data-wrangling/audit/README.md +++ b/subjects/ai/data-wrangling/audit/README.md @@ -81,7 +81,7 @@ #### Exercise 4: Groupby Apply -##### The exercise is validated is all questions of the exercise are validated and if the for loop hasn't been used. The goal is to use `groupby` and `apply`. +##### The exercise is validated if all questions of the exercise are validated and if the for loop hasn't been used. The goal is to use `groupby` and `apply`. ###### Is the output for question 1 the following? diff --git a/subjects/ai/keras-2/audit/README.md b/subjects/ai/keras-2/audit/README.md index c10d0a32a..c53ccd8aa 100644 --- a/subjects/ai/keras-2/audit/README.md +++ b/subjects/ai/keras-2/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercise is validated is all questions of the exercise 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`. diff --git a/subjects/ai/keras/audit/README.md b/subjects/ai/keras/audit/README.md index 62c2dc725..1d4a573c1 100644 --- a/subjects/ai/keras/audit/README.md +++ b/subjects/ai/keras/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercise is validated is all questions of the exercise 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` diff --git a/subjects/ai/linear-regression/audit/README.md b/subjects/ai/linear-regression/audit/README.md index 16024d00f..6f9be4c65 100644 --- a/subjects/ai/linear-regression/audit/README.md +++ b/subjects/ai/linear-regression/audit/README.md @@ -2,7 +2,7 @@ #### Exercise 0: Environment and libraries -##### The exercise is validated is all questions of the exercise 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` diff --git a/subjects/ai/model-selection/audit/README.md b/subjects/ai/model-selection/audit/README.md index 14d38c8d2..dea69286d 100644 --- a/subjects/ai/model-selection/audit/README.md +++ b/subjects/ai/model-selection/audit/README.md @@ -64,7 +64,7 @@ The model is consistent across folds: it is stable. That's a first sign that the #### Exercise 3: GridsearchCV -##### The exercise is validated is all questions of the exercise are validated +##### The exercise is validated if all questions of the exercise are validated ###### For question 1, is the code that runs the grid search similar to the following? @@ -84,7 +84,7 @@ gridsearch.fit(X_train, y_train) The answers that uses another list of parameters are accepted too ! -###### For question 2, whe these attributes used? +###### For question 2, were these attributes used? ```python print(gridsearch.best_score_) diff --git a/subjects/ai/neural-networks/audit/README.md b/subjects/ai/neural-networks/audit/README.md index 26ed141bb..dabc96a64 100644 --- a/subjects/ai/neural-networks/audit/README.md +++ b/subjects/ai/neural-networks/audit/README.md @@ -8,7 +8,7 @@ ###### Does it print `Python 3.x`? x >= 8 -##### Do `import jupyter` and `import numpy` run without any error? +###### Do `import jupyter` and `import numpy` run without any error? --- diff --git a/subjects/ai/nlp-spacy/audit/README.md b/subjects/ai/nlp-spacy/audit/README.md index 7ab26ebc2..0420bf1ad 100644 --- a/subjects/ai/nlp-spacy/audit/README.md +++ b/subjects/ai/nlp-spacy/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercise is all questions of the exercise are validated. +##### The exercise is is validated if all questions of the exercise are validated. ##### Activate the virtual environment. If you used `conda` run `conda activate your_env`. diff --git a/subjects/ai/pipeline/audit/README.md b/subjects/ai/pipeline/audit/README.md index 58dbccd01..bf8d47ad5 100644 --- a/subjects/ai/pipeline/audit/README.md +++ b/subjects/ai/pipeline/audit/README.md @@ -1,6 +1,6 @@ #### Exercise 0: Environment and libraries -##### The exercise is validated is all questions of the exercise 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`. diff --git a/subjects/ai/visualizations/audit/README.md b/subjects/ai/visualizations/audit/README.md index 390af780e..2f83d6393 100644 --- a/subjects/ai/visualizations/audit/README.md +++ b/subjects/ai/visualizations/audit/README.md @@ -8,7 +8,7 @@ ###### Does it print `Python 3.x`? x >= 8 -##### Do `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 errors? --- @@ -16,7 +16,7 @@ #### Exercise 1: Pandas plot 1 -##### The exercise is validated is all questions of the exercise are validated +##### The exercise is validated if all questions of the exercise are validated ###### For question 1, does the plot reproduce the plot in the image and respect those criteria?