Minor edits (#84)

* doc : SUPPORTED_MODELS.md updated

* doc : CI badges updated

* del : TODO.md removed

* doc : README.md titles modified

* doc : AUTHORS.md updated

* doc : project email changed to [email protected]

* doc : CONTRIBUTING.md test section updated

* doc : CHANGELOG.md updated

.github/CODE_OF_CONDUCT.md

@@ -58,7 +58,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-info@openscilab.com.
+pymilo@openscilab.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Please consider the following :
 2. Create your feature branch (under `dev` branch)
 3. Add your functions/methods to proper files
 4. Add standard `docstring` to your functions/methods
-5. Add tests for your functions/methods (`doctest` testcases in `test` folder)
+5. Add tests for your functions/methods (`tests` folder)
 6. Pass all CI tests
 7. Update `CHANGELOG.md`
 	- Describe changes under `[Unreleased]` section

AUTHORS.md

@@ -1,8 +1,8 @@
 # Authors #
 
 ----------
-- Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
 - AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
+- Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
 - Alireza Zolanvari  - Open Science Laboratory ([Github](https://github.com/AlirezaZolanvari))
 - Sadra Sabouri - Open Science Laboratory ([Github](https://github.com/sadrasabouri))
 

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ### Added
 ### Changed
+- `SUPPORTED_MODELS.md` updated
+- `README.md` updated
 ## [0.5] - 2024-01-31
 ### Added
 - `reset` function in the `Transport` interface

README.md

@@ -24,7 +24,6 @@
 * [Installation](https://github.com/openscilab/pymilo#installation)
 * [Usage](https://github.com/openscilab/pymilo#usage)
 * [Issues & Bug Reports](https://github.com/openscilab/pymilo#issues--bug-reports)
-* [Todo](https://github.com/openscilab/pymilo/blob/main/TODO.md)
 * [Contribution](https://github.com/openscilab/pymilo/blob/main/.github/CONTRIBUTING.md)
 * [Authors](https://github.com/openscilab/pymilo/blob/main/AUTHORS.md)
 * [License](https://github.com/openscilab/pymilo/blob/main/LICENSE)
@@ -64,10 +63,10 @@ PyMilo is an open source Python package that provides a simple, efficient, and s
     <tr>
         <td align="center">CI</td>
         <td align="center">
-            <img src="https://github.com/openscilab/pymilo/workflows/CI/badge.svg?branch=main">
+            <img src="https://github.com/openscilab/pymilo/actions/workflows/test.yml/badge.svg?branch=main">
         </td>
         <td align="center">
-            <img src="https://github.com/openscilab/pymilo/workflows/CI/badge.svg?branch=dev">
+            <img src="https://github.com/openscilab/pymilo/actions/workflows/test.yml/badge.svg?branch=dev">
             </td>
     </tr>
 </table>
@@ -93,7 +92,7 @@ PyMilo is an open source Python package that provides a simple, efficient, and s
 - Run `pip install .`
 
 ## Usage
-### Simple Linear Model Preparation 
+### Model preparation 
 ```pycon
 >>> from sklearn import datasets
 >>> from pymilo import Export, Import
@@ -107,25 +106,25 @@ PyMilo is an open source Python package that provides a simple, efficient, and s
 >>> #### Train the model using the training sets
 >>> model.fit(X_train, Y_train)
 ```
-### Save Model 
+### Save model 
 ```pycon
 >>> #### Export the fitted model to a transparent json file
 >>> exported_model = Export(model)
 >>> PATH_TO_JSON_FILE = os.path.join(os.getcwd(),"test.json")
 >>> exported_model.save(PATH_TO_JSON_FILE)
 ```
-### Load Model
+### Load model
 ```pycon
 >>> #### Import the pymilo-exported model and get a real scikit model
 >>> imported_model = Import(PATH_TO_JSON_FILE)
 ```
-### Get the associated Scikit model
+### Get the associated model
 ```pycon 
 >>> imported_sklearn_model = imported_model.to_model()
 ```
 #### Note: `imported_sklearn_model` has the **exact same** functionality as the `model` object earlier.
 
-## Supported ML Models
+## Supported ML models
 | scikit-learn | PyTorch | 
 | ---------------- | ---------------- | 
 | Linear Models &#x2705; | - | 
@@ -140,7 +139,7 @@ Details are available in [Supported Models](https://github.com/openscilab/pymilo
 
 ## Issues & bug reports
 
-Just fill an issue and describe it. We'll check it ASAP! or send an email to [info@openscilab.com](mailto:info@openscilab.com "info@openscilab.com"). 
+Just fill an issue and describe it. We'll check it ASAP! or send an email to [pymilo@openscilab.com](mailto:pymilo@openscilab.com "pymilo@openscilab.com"). 
 
 - Please complete the issue template
 
@@ -151,7 +150,7 @@ You can also join our discord server
 </a>
 
 
-## Show Your Support
+## Show your support
 
 
 ### Star this repo

SUPPORTED_MODELS.md

@@ -1,6 +1,6 @@
 # Supported Models
 
-### Last Update: 2023-12-06
+### Last Update: 2024-02-25
 
 ## Table of Contents
 
@@ -391,7 +391,7 @@
         <td>>=0.5</td>
 	</tr>
 	<tr align="center">
-		<td>4</td>
+		<td>5</td>
 		<td><b>Categorical Naive Bayes</b></td>
         <td>>=0.5</td>
 	</tr>

setup.py

@@ -39,7 +39,7 @@ def read_description():
     long_description=read_description(),
     long_description_content_type='text/markdown',
     author='PyMilo Development Team',
-    author_email='info@openscilab.com',
+    author_email='pymilo@openscilab.com',
     url='https://github.com/openscilab/pymilo',
     download_url='https://github.com/openscilab/pymilo/tarball/v0.5',
     keywords="python3 python machine_learning ML",