Skip to content

Commit 01771f3

Browse files
committed
Update docs
1 parent c0f130f commit 01771f3

File tree

2 files changed

+39
-36
lines changed

2 files changed

+39
-36
lines changed

docs/source/pages/quick_start.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ If you want to use the Whale Optimization-based ELM (WO-ELM) model, you can chan
9595
9696
opt_paras = {"name": "WOA", "epoch": 100, "pop_size": 30}
9797
model = MhaElmRegressor(layer_sizes=(10, ), act_name="elu", obj_name="MSE",
98-
optim="OriginalWOA", optim_params=opt_paras, verbose=False, seed=42)
98+
optim="OriginalWOA", optim_params=opt_paras, verbose=False, seed=42,
99+
lb=None, ub=None, mode='single', n_workers=None, termination=None)
99100
100101
In the example above, I had to import the MhaElmRegressor class. This is the class that contains all Metaheuristics-based ELM models for regression problems.
101102
Then, I defined parameters for the Whale Optimization algorithm. And I defined parameters for the Whale Optimization-based ELM model.
@@ -110,7 +111,8 @@ MhaElmClassifier class (these are hybrid models combining metaheuristics algorit
110111
111112
from intelelm import ElmClassifier
112113
113-
model = ElmClassifier(layer_sizes=(10, ), act_name="elu", seed=42)
114+
model = ElmClassifier(layer_sizes=(10, ), act_name="elu", seed=42,
115+
lb=None, ub=None, mode='single', n_workers=None, termination=None)
114116
115117
116118
@@ -120,7 +122,8 @@ MhaElmClassifier class (these are hybrid models combining metaheuristics algorit
120122
121123
opt_paras = {"name": "GA", "epoch": 100, "pop_size": 30}
122124
model = MhaElmClassifier(layer_sizes=(10, ), act_name="elu", obj_name="BSL",
123-
optim="BaseGA", optim_params=opt_paras, verbose=False, seed=42)
125+
optim="BaseGA", optim_params=opt_paras, verbose=False, seed=42,
126+
lb=None, ub=None, mode='single', n_workers=None, termination=None)
124127
125128
126129
-------------------
@@ -167,8 +170,9 @@ library to split and scale the data.
167170
##### 5.2: Use Metaheuristic-based ELM model for classification problem
168171
print(MhaElmClassifier.SUPPORTED_OPTIMIZERS)
169172
print(MhaElmClassifier.SUPPORTED_CLS_OBJECTIVES)
170-
opt_paras = {"name": "GA", "epoch": 10, "pop_size": 30}
171-
classifier = MhaElmClassifier(layer_sizes=(10, ), act_name="elu", obj_name="KLDL", optim="BaseGA", optim_params=opt_paras, seed=42)
173+
classifier = MhaElmClassifier(layer_sizes=(10, ), act_name="elu", obj_name="KLDL",
174+
optim="BaseGA", optim_params={"name": "GA", "epoch": 10, "pop_size": 30}, seed=42,
175+
lb=None, ub=None, mode='single', n_workers=None, termination=None)
172176
173177
#### Step 6: Traint the model
174178
classifer.fit(X_train, y_train)
@@ -217,7 +221,8 @@ In the example below, we use the Whale Optimization-based ELM model as the base
217221
# create model and selector
218222
opt_paras = {"name": "GA", "epoch": 100, "pop_size": 30}
219223
model = MhaElmRegressor(layer_sizes=(10, ), act_name="relu", obj_name="MSE",
220-
optim="BaseGA", optim_params=opt_paras, verbose=False, seed=42)
224+
optim="BaseGA", optim_params=opt_paras, verbose=False, seed=42,
225+
lb=None, ub=None, mode='single', n_workers=None, termination=None))
221226
222227
selector = RFE(estimator=model)
223228
selector.fit(X_train, y_train)

docs/source/pages/support.rst

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,38 @@ Citation Request
88
The paper can be accessed at the following `this link <https://doi.org/10.1016/j.procs.2020.03.063>`_
99

1010

11-
Please include these citations if you plan to use this library
12-
13-
.. bibtex::
11+
Please include these citations if you plan to use this library::
1412

1513
@article{van2025intelelm,
16-
title={IntelELM: A python framework for intelligent metaheuristic-based extreme learning machine},
17-
author={Van Thieu, Nguyen and Houssein, Essam H and Oliva, Diego and Hung, Nguyen Duy},
18-
journal={Neurocomputing},
19-
volume={618},
20-
pages={129062},
21-
year={2025},
22-
publisher={Elsevier},
23-
doi={10.1016/j.neucom.2024.129062}
14+
title={IntelELM: A python framework for intelligent metaheuristic-based extreme learning machine},
15+
author={Van Thieu, Nguyen and Houssein, Essam H and Oliva, Diego and Hung, Nguyen Duy},
16+
journal={Neurocomputing},
17+
volume={618},
18+
pages={129062},
19+
year={2025},
20+
publisher={Elsevier},
21+
doi={10.1016/j.neucom.2024.129062}
22+
}
23+
24+
@article{nguyen2020new,
25+
title={A new workload prediction model using extreme learning machine and enhanced tug of war optimization},
26+
author={Nguyen, Thieu and Hoang, Bao and Nguyen, Giang and Nguyen, Binh Minh},
27+
journal={Procedia Computer Science},
28+
volume={170},
29+
pages={362--369},
30+
year={2020},
31+
publisher={Elsevier},
32+
doi={10.1016/j.procs.2020.03.063}
2433
}
2534

26-
@article{nguyen2020new,
27-
title={A new workload prediction model using extreme learning machine and enhanced tug of war optimization},
28-
author={Nguyen, Thieu and Hoang, Bao and Nguyen, Giang and Nguyen, Binh Minh},
29-
journal={Procedia Computer Science},
30-
volume={170},
31-
pages={362--369},
32-
year={2020},
33-
publisher={Elsevier},
34-
doi={10.1016/j.procs.2020.03.063}
35-
}
36-
37-
@article{van2023mealpy,
38-
title={MEALPY: An open-source library for latest meta-heuristic algorithms in Python},
39-
author={Van Thieu, Nguyen and Mirjalili, Seyedali},
40-
journal={Journal of Systems Architecture},
41-
year={2023},
42-
publisher={Elsevier},
43-
doi={10.1016/j.sysarc.2023.102871}
44-
}
35+
@article{van2023mealpy,
36+
title={MEALPY: An open-source library for latest meta-heuristic algorithms in Python},
37+
author={Van Thieu, Nguyen and Mirjalili, Seyedali},
38+
journal={Journal of Systems Architecture},
39+
year={2023},
40+
publisher={Elsevier},
41+
doi={10.1016/j.sysarc.2023.102871}
42+
}
4543

4644

4745
If you have an open-ended or a research question, you can contact me via [email protected]

0 commit comments

Comments
 (0)