-
-
Notifications
You must be signed in to change notification settings - Fork 223
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature/improve documentation (#1028)
* Experimental instruction for installing SMAC in windows via WSL * More detailed documentation regarding continuing runs * Fixes * Fixes * Fixes * Update docs/10_experimental.rst Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com> * Fixes from PR * Fixes from PR * Fixes from PR * Fixes from PR * Fixes from PR --------- Co-authored-by: Difan Deng <33290713+dengdifan@users.noreply.github.com>
- Loading branch information
1 parent
5aa921a
commit 83eaab5
Showing
7 changed files
with
87 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
Experimental | ||
============ | ||
|
||
.. warning:: | ||
This part is experimental and might not work in each case. If you would like to suggest any changes, please let us know. | ||
|
||
|
||
Installation in Windows via WSL | ||
------------------------------ | ||
|
||
SMAC can be installed in a WSL (Windows Subsystem for Linux) under Windows. | ||
|
||
**1) Install WSL under Windows** | ||
|
||
Install WSL under Windows. This SMAC installation workflow was tested with Ubuntu 18.04. For Ubuntu 20.04, | ||
it has been observed that the SMAC installation results in a segmentation fault (core dumped). | ||
|
||
**2) Get Anaconda** | ||
|
||
Download an Anaconda Linux version to drive D under Windows, e.g. D:\\Anaconda3-2023.03-1-Linux-x86_64 | ||
|
||
In the WSL, Windows resources are mounted under /mnt: | ||
|
||
.. code:: bash | ||
cd /mnt/d | ||
bash Anaconda3-2023.03-1-Linux-x86_64 | ||
Enter this command to create the environment variable: | ||
|
||
.. code:: bash | ||
export PATH="$PATH:/home/${USER}/anaconda3/bin | ||
Input 'python' to check if the installation was successful. | ||
**3) Install SMAC** | ||
Change to your home folder and install the general software there: | ||
.. code:: bash | ||
cd /home/${USER} | ||
sudo apt-get install software-properties-common | ||
sudo apt-get update | ||
sudo apt-get install build-essential swig | ||
conda install gxx_linux-64 gcc_linux-64 swig | ||
curl https://raw.githubusercontent.com/automl/smac3/master/requirements.txt | xargs -n 1 -L 1 pip install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,23 @@ | ||
Continue | ||
======== | ||
|
||
SMAC automatically restores states where it left off if a run was interrupted or finished. To do so, it reads in old | ||
files (derived from scenario's name, output_directory and seed) and sets the components. | ||
SMAC can automatically restore states where it left off if a run was interrupted or prematurely finished. To do so, | ||
it reads in old files (derived from scenario's name, output_directory and seed) and obtains the scenario information | ||
of the previous run from those to continue the run. | ||
|
||
The behavior can be controlled by setting the parameter ``overwrite`` in the facade to True or False, respectively: | ||
|
||
* If set to True, SMAC overwrites the run results if a previous run is found that is consistent in the meta data with the current setup. | ||
* If set to False and a previous run is found that | ||
|
||
* is consistent in the meta data, the run is continued. | ||
* is not consistent in the meta data, the user is asked for the exact behaviour (overwrite completely or rename old run first). | ||
|
||
.. warning:: | ||
|
||
If you changed any code and specified a name, SMAC will ask you whether you still want to resume or | ||
delete the old run completely. If you did not specify a name, SMAC generates a new name and the old run is | ||
not affected. | ||
If you changed any code affecting the run's meta data and specified a name, SMAC will ask you whether you still | ||
want to overwrite the old run or rename the old run first. If you did not specify a name, SMAC generates a new name | ||
and the old run is not affected. | ||
|
||
|
||
Please have a look at our :ref:`continue example<Continue an Optimization>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters