Skip to content

Commit 6558e75

Browse files
anh9895anh9895
committed
Update docs
1 parent 55d3545 commit 6558e75

File tree

4 files changed

+72
-59
lines changed

4 files changed

+72
-59
lines changed

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
author = 'Thieu'
3131

3232
# The full version, including alpha/beta/rc tags
33-
release = '0.2.0'
33+
release = '1.0.0'
3434

3535

3636
# -- General configuration ---------------------------------------------------

‎docs/source/index.rst‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Welcome to MAFESE's documentation!
77
==================================
88

9-
.. image:: https://img.shields.io/badge/release-0.2.0-yellow.svg
9+
.. image:: https://img.shields.io/badge/release-1.0.0-yellow.svg
1010
:target: https://github.com/thieu1995/mafese/releases
1111

1212
.. image:: https://img.shields.io/pypi/wheel/gensim.svg
@@ -18,35 +18,23 @@ Welcome to MAFESE's documentation!
1818
.. image:: https://img.shields.io/pypi/pyversions/mafese.svg
1919
:target: https://www.python.org/
2020

21-
.. image:: https://img.shields.io/pypi/status/mafese.svg
22-
:target: https://img.shields.io/pypi/status/mafese.svg
23-
2421
.. image:: https://img.shields.io/pypi/dm/mafese.svg
2522
:target: https://img.shields.io/pypi/dm/mafese.svg
2623

27-
.. image:: https://github.com/thieu1995/mafese/actions/workflows/publish-package.yaml/badge.svg
28-
:target: https://github.com/thieu1995/mafese/actions/workflows/publish-package.yaml
29-
3024
.. image:: https://static.pepy.tech/badge/mafese
3125
:target: https://pepy.tech/project/mafese
3226

33-
.. image:: https://img.shields.io/github/release-date/thieu1995/mafese.svg
34-
:target: https://img.shields.io/github/release-date/thieu1995/mafese.svg
27+
.. image:: https://github.com/thieu1995/mafese/actions/workflows/test.yml/badge.svg
28+
:target: https://github.com/thieu1995/mafese/actions/workflows/test.yml
3529

3630
.. image:: https://readthedocs.org/projects/mafese/badge/?version=latest
3731
:target: https://mafese.readthedocs.io/en/latest/?badge=latest
3832

3933
.. image:: https://img.shields.io/badge/Chat-on%20Telegram-blue
4034
:target: https://t.me/+fRVCJGuGJg1mNDg1
4135

42-
.. image:: https://img.shields.io/github/contributors/thieu1995/mafese.svg
43-
:target: https://img.shields.io/github/contributors/thieu1995/mafese.svg
44-
45-
.. image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
46-
:target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
47-
48-
.. image:: https://zenodo.org/badge/545209353.svg
49-
:target: https://doi.org/10.5281/zenodo.7969042
36+
.. image:: https://img.shields.io/badge/DOI-10.1016%2Fj.future.2024.06.006-blue
37+
:target: https://doi.org/10.1016/j.future.2024.06.006
5038

5139
.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
5240
:target: https://www.gnu.org/licenses/gpl-3.0
@@ -64,7 +52,7 @@ using meta-heuristic algorithms.
6452
* **Total performance metrics**: >= 61 (45 regressions and 16 classifications)
6553
* **Total objective functions (as fitness functions)**: >= 61 (45 regressions and 16 classifications)
6654
* **Documentation:** https://mafese.readthedocs.io/en/latest/
67-
* **Python versions:** >= 3.7.x
55+
* **Python versions:** >= 3.8.x
6856
* **Dependencies:** numpy, scipy, scikit-learn, pandas, mealpy, permetrics, plotly, kaleido
6957

7058

‎docs/source/pages/quick_start.rst‎

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -31,35 +31,40 @@ Lib's structure
3131

3232
Current's structure::
3333

34-
docs
35-
examples
36-
mafese
37-
data/
38-
cls/
39-
...csv
40-
reg/
41-
...csv
42-
wrapper/
43-
mha.py
44-
recursive.py
45-
sequential.py
46-
embedded/
47-
lasso.py
48-
tree.py
49-
filter.py
50-
unsupervised.py
51-
utils/
52-
correlation.py
53-
data_loader.py
54-
encoder.py
55-
estimator.py
56-
mealpy_util.py
57-
transfer.py
58-
validator.py
59-
__init__.py
60-
selector.py
61-
README.md
62-
setup.py
34+
docs
35+
examples
36+
mafese
37+
data/
38+
cls/
39+
aggregation.csv
40+
Arrhythmia.csv
41+
...
42+
reg/
43+
boston-housing.csv
44+
diabetes.csv
45+
...
46+
wrapper/
47+
mha.py
48+
recursive.py
49+
sequential.py
50+
embedded/
51+
lasso.py
52+
tree.py
53+
filter.py
54+
unsupervised.py
55+
utils/
56+
correlation.py
57+
data_loader.py
58+
encoder.py
59+
estimator.py
60+
mealpy_util.py
61+
transfer.py
62+
validator.py
63+
__init__.py
64+
selector.py
65+
README.md
66+
setup.py
67+
6368

6469
========
6570
Examples
@@ -184,11 +189,13 @@ Or, use Metaheuristic-based feature selection with different metaheuristic algor
184189
print(data.X_train.shape, data.X_test.shape) # (361, 279) (91, 279)
185190

186191
# define mafese feature selection method
187-
feat_selector = MhaSelector(problem="classification", estimator="knn",
188-
optimizer="BaseGA", optimizer_paras=None,
189-
transfer_func="vstf_01", obj_name="AS")
192+
feat_selector = MhaSelector(problem="classification",obj_name="AS",
193+
estimator="knn", estimator_paras=None,
194+
optimizer="BaseGA", optimizer_paras=None,
195+
mode='single', n_workers=None, termination=None, seed=None, verbose=True)
196+
190197
# find all relevant features
191-
feat_selector.fit(data.X_train, data.y_train, fit_weights=(0.9, 0.1), verbose=True)
198+
feat_selector.fit(data.X_train, data.y_train, fit_weights=(0.9, 0.1))
192199

193200
# check selected features - True (or 1) is selected, False (or 0) is not selected
194201
print(feat_selector.selected_feature_masks)

‎docs/source/pages/support.rst‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Citation Request
55
Please include these citations if you plan to use this incredible library::
66

77
@article{thieu2024feature,
8-
title={Feature selection using metaheuristics made easy: Open source MAFESE library in Python},
9-
author={Van Thieu, Nguyen and Nguyen, Ngoc Hung and Heidari, Ali Asghar},
10-
journal={Future Generation Computer Systems},
11-
year={2024},
12-
publisher={Elsevier},
13-
doi={10.1016/j.future.2024.06.006},
14-
url={https://doi.org/10.1016/j.future.2024.06.006},
8+
title={Feature selection using metaheuristics made easy: Open source MAFESE library in Python},
9+
author={Van Thieu, Nguyen and Nguyen, Ngoc Hung and Heidari, Ali Asghar},
10+
journal={Future Generation Computer Systems},
11+
year={2024},
12+
publisher={Elsevier},
13+
doi={10.1016/j.future.2024.06.006},
14+
url={https://doi.org/10.1016/j.future.2024.06.006},
1515
}
1616

1717
@software{nguyen_van_thieu_2023_7969043,
@@ -58,6 +58,24 @@ Important links
5858
* https://github.com/aiir-team
5959

6060

61+
62+
=====================
63+
Some support websites
64+
=====================
65+
66+
1. https://neptune.ai/blog/feature-selection-methods
67+
2. https://www.blog.trainindata.com/feature-selection-machine-learning-with-python/
68+
3. https://github.com/LBBSoft/FeatureSelect
69+
4. https://bmcbioinformatics.biomedcentral.com/articles/10.1186/s12859-019-2754-0
70+
5. https://github.com/scikit-learn-contrib/boruta_py
71+
6. https://elki-project.github.io/
72+
7. https://sci2s.ugr.es/keel/index.php
73+
8. https://archive.ics.uci.edu/datasets
74+
9. https://python-charts.com/distribution/box-plot-plotly/
75+
10. https://plotly.com/python/box-plots/?_ga=2.50659434.2126348639.1688086416-114197406.1688086416#box-plot-styling-mean--standard-deviation
76+
77+
78+
6179
=======
6280
License
6381
=======

0 commit comments

Comments
 (0)