First formal version of README #212

Author: dpuenteramirez

README.md

@@ -9,64 +9,76 @@ alt="ISMSSL by DNX"></a>
   <br>
 </h1>
 
+---
 <h4 align="center">Instance selection methods for semi-supervised learning.</h4>
+<div align="center">
+  <img alt="Codacy coverage" src="https://img.shields.io/codacy/coverage/c336db4b8f9b4196bc802a544a18b83b?logo=codacy">
+  <img alt="Codacy grade" src="https://img.shields.io/codacy/grade/c336db4b8f9b4196bc802a544a18b83b?logo=codacy">
+  <img alt="SonarCloud Build Status" src="https://sonarcloud.io/api/project_badges/measure?project=dpr1005_Semisupervised-learning-and-instance-selection-methods&metric=alert_status">
+  <img alt="SonarCloud Security" src="https://sonarcloud.io/api/project_badges/measure?project=dpr1005_Semisupervised-learning-and-instance-selection-methods&metric=security_rating">
+  <img alt="DeepSource" src="https://deepsource.io/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods.svg/?label=active+issues&show_trend=true&token=_L2oEwtETgWq6CnhDB1m8qO6)](https://deepsource.io/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods/?ref=repository-badge"> 
+  <br/>
+  <a href="https://github.com/dpr1005/Semisupervised-learning-and-instance-selection-methods/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/dpr1005/Semisupervised-learning-and-instance-selection-methods"></a>
+<a href="https://github.com/dpr1005/Semisupervised-learning-and-instance-selection-methods/network/members"><img alt="GitHub forks" src="https://img.shields.io/github/forks/dpr1005/Semisupervised-learning-and-instance-selection-methods"></a>
+<a href="https://github.com/dpr1005/Semisupervised-learning-and-instance-selection-methods/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/dpr1005/Semisupervised-learning-and-instance-selection-methods"></a>
+<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/dpr1005/Semisupervised-learning-and-instance-selection-methods">
+  <a href="https://github.com/dpr1005/Semisupervised-learning-and-instance-selection-methods/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/dpr1005/Semisupervised-learning-and-instance-selection-methods"></a>
+  <br/>
+  <img alt="Non Comment Lines Of Code" src="https://sonarcloud.io/api/project_badges/measure?project=dpr1005_Semisupervised-learning-and-instance-selection-methods&metric=ncloc">
+  <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/dpr1005/Semisupervised-learning-and-instance-selection-methods?color=purple&logo=github">
+</div>
 
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c336db4b8f9b4196bc802a544a18b83b)](https://www.codacy.com/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dpr1005/Semisupervised-learning-and-instance-selection-methods&amp;utm_campaign=Badge_Grade)
- [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dpr1005_Semisupervised-learning-and-instance-selection-methods&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dpr1005_Semisupervised-learning-and-instance-selection-methods)
- [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/c336db4b8f9b4196bc802a544a18b83b)](https://www.codacy.com/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods/dashboard?utm_source=github.com&utm_medium=referral&utm_content=dpr1005/Semisupervised-learning-and-instance-selection-methods&utm_campaign=Badge_Coverage)
-[![DeepSource](https://deepsource.io/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods.svg/?label=active+issues&show_trend=true&token=_L2oEwtETgWq6CnhDB1m8qO6)](https://deepsource.io/gh/dpr1005/Semisupervised-learning-and-instance-selection-methods/?ref=repository-badge)
-
+---
 <p align="center">
-  <a href="#key-features">Key Features</a> •
-  <a href="#setup">Setup</a> •
-  <a href="#usage-guide">Usage guide</a> •
-  <a href="#download">Download</a> •
-  <a href="#credits">Credits</a> •
-  <a href="#related">Related</a> •
-  <a href="#license">License</a>
+  <a href="#description">Project Description</a> •
+  <a href="#download-and-installation">Download and Installation</a> •
+  <a href="#dependencies">Dependencies</a> •
+  <a href="#support">Support</a>
 </p>
 
 
+---
+## Description
+This project has an implementation of common algorithms in the literature, both instance selection algorithms and semi-supervised learning algorithms.
 
-## Key Features
-
-* TBD
-
-## Setup
-
-TBD
+Among the objectives of the project is that the implemented algorithms are correct and complete with their respective original papers in which they were presented.
 
-## Usage guide
+Likewise, there are multiple experiment configuration files for the aforementioned verification, and for the realization of a research process on the behavior of semi-supervised learning algorithms when noise filtering is performed.
 
-TBD
+---
+## Download and installation
+IS-SSL is distributed under two libraries, both are available in their last 
+versions in PIP. 
+- Instance Selection Algorithms. [PIP](https://pypi.org/project/InstanceSelectionDNX/).
+  
+````bash
+pip install InstanceSelectionDNX
+````
 
+- Semi-Supervised Algorithms. [PIP](https://pypi.org/project/SemiSupervisedLearningDNX/).
+````bash
+pip install SemiSupervisedLearningDNX
+````
 
-## Download
+Being the nature a Python project, it is easily importable from within the 
+repo and its [releases](https://github.com/dpr1005/Semisupervised-learning-and-instance-selection-methods/releases).
 
-TBD
 
-## Credits
+---
+## Dependencies
 
 This software uses the following open source packages:
 
-- [scikit-learn](https://sklearn.org)
 - [NumPy](https://numpy.org)
+- [Pandas](https://pandas.pydata.org/)
+- [Scikit-Learn](https://sklearn.org)
+- [Scipy](https://scipy.org)
 
-
-## Related
-
-TBD
-
+---
 ## Support
-
 <a href="https://buymeacoffee.com/danielpuente" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
 
 
-
-## License
-
-MIT
-
 ---
 
 > GitHub [@dpr1005](https://github.com/dpr1005) &nbsp;&middot;&nbsp;