update basic rules
"\n",
"* The **Regex Scanner** (or Scanner) is the basic component because it provides the regular expression scan on the GitHub repositories. In the installation, you configured a set of rules (from the .yml file) and it is still possible to add/remove your own rules\n",
"\n",
- "* The **Path Model**: A lot of the discoveries are in example files such as documentations, README, etc... since it is very common for developers to provide test codes for their projects. The Path Model analyzes the *path* of each discovery and classify it as false positive when needed\n",
+ "* The **Path Model**: A lot of the discoveries are in example files such as documentations, README, etc. since it is very common for developers to provide test codes for their projects. The Path Model analyzes the *path* of each discovery and classifies it as false positive when needed\n",
"\n",
"* The **Snippet Models**: Now, we are tackling the most difficult part to detect a false positive: the code snippet. Two steps are required: a pre-processing step (called **Extractor**) and classification step (called **Classifier**). The output of the Classifier will contain the discoveries with a reduced amount of false positive.\n",
"\n",
- "Finally, a user can review the filtered discoveries by *flagging* a discovery as false positive (see in later sections). The machine learning can be enabled or disabled, depending on your use case. For more advanced users, it is possible to integrate your own model directly to Credential Digger.\n"
+ "Finally, a user can review the filtered discoveries by *flagging* a discovery as false positive (see in later sections). The machine learning models can be enabled or disabled, depending on your use case. For more advanced users, it is possible to integrate your own model directly to Credential Digger.\n"
]
},
{
"* You can scan a new repository, by clicking on **Scan Repo**\n",
"* You can manage the rules you want to integrate for the scanner by clicking on **Rules**\n",
"\n",
- "Let's say we want to scan a new repository. We click on **Scan Repo**, we select the category of rules we want (either API Keys, password, etc..), we select the URL of the GitHub repository we want to scan and we click on **Start Scan**"
+ "Let's say we want to scan a new repository. We click on **Scan Repo**, we select the category of rules we want (either API Keys, password, etc.), we select the URL of the GitHub repository we want, and we check the Machine Learning models that we want to apply to automatically reduce false positives. Then, we click on **Start Scan** to start the scan"
]
},
{
