Browse Source

docs(nlp-scraper): fix audits format

pull/1687/head
eslopfer 2 years ago
parent
commit
c4b718443d
  1. 14
      subjects/ai/nlp-scraper/audit/README.md

14
subjects/ai/nlp-scraper/audit/README.md

@ -20,9 +20,9 @@ project
``` ```
###### Does the structure of the project is as below ? ###### Does the structure of the project look like the above?
###### Does the readme file give an introduction of the project, show the username, describe the feature engineering and show the best score the on the leaderboard ? ###### Does the readme file give an introduction of the project, show the username, describe the feature engineering and show the best score on the leaderboard?
###### Does the environment contain all libraries used and their versions that are necessary to run the code? ###### Does the environment contain all libraries used and their versions that are necessary to run the code?
@ -30,15 +30,15 @@ project
##### There are at least 300 news articles stored in the file system or the database. ##### There are at least 300 news articles stored in the file system or the database.
##### Run the scrapper with `python scrapper_news.py` and fetch 3 documents. The scrapper is not expected to fetch 3 documents and stop by itself, you can stop it manually. It runs without any error and stores the 3 files as expected. ###### Run the scrapper with `python scrapper_news.py` and fetch 3 documents. The scrapper is not expected to fetch 3 documents and stop by itself, you can stop it manually. does it run without any error and store the 3 files as expected?
##### Topic classifier ##### Topic classifier
###### Are the learning curves provided? ###### Are the learning curves provided?
###### Do the learning curves prove the topics classifier is trained without correctly - without overfitting ? ###### Do the learning curves prove the topics classifier is trained correctly - without overfitting?
###### Can you run the topic classfier model on the test set without any error ? ###### Can you run the topic classifier model on the test set without any error?
###### Does the topic classifier score an accuracy higher than 95%? ###### Does the topic classifier score an accuracy higher than 95%?
@ -50,13 +50,11 @@ project
###### Is the distance or similarity saved in the DataFrame? ###### Is the distance or similarity saved in the DataFrame?
#####
##### NLP engine output on 300 articles ##### NLP engine output on 300 articles
###### Does the DataFrame contain 300 different rows? ###### Does the DataFrame contain 300 different rows?
###### Does the columns of the DataFrame are as expected ? ###### Are the columns of the DataFrame as expected?
``` ```
Date scrapped (date) Date scrapped (date)

Loading…
Cancel
Save