Skip to content

Commit cf184e9

Browse files
Extend docs (#1309)
* re-structure manual and use 'collapse' * ADD link to auto-sklearn-talks * unifying titles * Clarify default memory and cpu usage * FIX sphinx_gallery to <=0.10.0 0.10.1 would raise an error for '-D plot_gallery=0' * Re-structure faq * FIX comments by mfeurer * boldface items * merge manual into FAQ * FIX minor * FIX typo * Update doc/faq.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/faq.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/faq.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/faq.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/manual.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/manual.rst Co-authored-by: Eddie Bergman <[email protected]> * Update doc/faq.rst Co-authored-by: Eddie Bergman <[email protected]> * FIX link Co-authored-by: Eddie Bergman <[email protected]>
1 parent 645e97a commit cf184e9

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

autosklearn/estimators.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,13 @@ def __init__(
9797
Memory limit in MB for the machine learning algorithm.
9898
`auto-sklearn` will stop fitting the machine learning algorithm if
9999
it tries to allocate more than ``memory_limit`` MB.
100+
101+
**Important notes:**
102+
103+
* If ``None`` is provided, no memory limit is set.
104+
* In case of multi-processing, ``memory_limit`` will be *per job*, so the total usage is
105+
``n_jobs x memory_limit``.
106+
* The memory limit also applies to the ensemble creation process.
100107
101108
**Important notes:**
102109

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@
198198
('Start', 'index'),
199199
('Releases', 'releases'),
200200
('Installation', 'installation'),
201-
('Manual', 'manual'),
201+
#('Manual', 'manual'),
202202
('Examples', 'examples/index'),
203203
('API', 'api'),
204204
('Extending', 'extending'),

setup.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,11 @@
4141
"seaborn",
4242
],
4343
"docs": [
44-
"sphinx<4.3",
45-
"sphinx-gallery",
44+
"sphinx",
45+
"sphinx-gallery<=0.10.0",
4646
"sphinx_bootstrap_theme",
4747
"numpydoc",
4848
"sphinx_toolbox",
49-
"docutils==0.16"
5049
],
5150
}
5251

0 commit comments

Comments
 (0)