You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/_sources/guide.rst.txt
+16-62
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@ Comprehensive Guide
3
3
=======================================
4
4
5
5
6
-
This is a comprehensive guide detailing the arguments which OptTask accepts, and, since OptTask is defined by its arguments, general usage tips.
7
-
This is best used as a reference guide after looking through the examples and tutorials.
6
+
Outside of the tutorial, all of rocketsled's configuration (which OptTask reads) can be done through the MissionControl class.
7
+
The following documentation details all the possible arguments to MissionControl.configure(...), which controls the execution and optimization parameters OptTask uses.
8
8
9
9
10
10
=======================================
@@ -15,7 +15,7 @@ Required Arguments
15
15
:code:`wf_creator`
16
16
--------------
17
17
18
-
This is a string which defines the function returning your optimization loop workflow. The function represented by this string must
18
+
This is a function object which takes in an input vector x and returns your optimization loop workflow. The function must
19
19
20
20
1. Accept x
21
21
2. Return a Fireworks workflow based on x (i.e., x sets some parameters in the workflow)
@@ -24,6 +24,17 @@ This is a string which defines the function returning your optimization loop wor
24
24
25
25
The workflow that is returned should have OptTask contained somewhere in it. Since OptTask is in the workflow, this is somewhat recursive.
26
26
27
+
You can also pass in full string path of the wf_creator function.
28
+
29
+
**Example**
30
+
31
+
.. code-block:: python
32
+
33
+
wf_creator=my_wf_creator_fun_object
34
+
35
+
36
+
Alternatively, define it with a string.
37
+
27
38
**Example**
28
39
29
40
.. code-block:: python
@@ -82,61 +93,10 @@ Database Setup
82
93
______________
83
94
84
95
85
-
When setting up the database, one MongoDB collection is needed to store optimization data. We recommend using the database
86
-
you use for your production FireWorks workflows, using a collection name not already used by Fireworks. By default, the collection
87
-
name will be opt_default.
88
-
89
-
There are 3 main ways to specify where to store optimization data:
90
-
91
-
1. Use :code:`host`, :code:`port`, and :code:`name`
92
-
2. Use :code:`lpad`
93
-
3. Let launchapd auto_load, if applicable.
94
-
95
-
96
-
:code:`host`
97
-
--------------
98
-
99
-
The host of the MongoDB instance you are going to store optimization data in. port and name must also be specified if this is specified.
100
-
101
-
**Examples**
102
-
103
-
.. code-block:: python
104
-
105
-
# host should be a string
106
-
host='localhost'
107
-
108
-
# remote
109
-
host='my_webserver.com'
110
-
96
+
To set up the databsae
111
97
112
-
:code:`port`
113
-
--------------
114
-
115
-
The port of the MongodDB instance you are going to store optimization data in. host and name must also be specified if this is specified.
116
-
117
-
**Examples**
118
-
119
-
.. code-block:: python
120
98
121
-
# Port should be an integer
122
-
port=27017
123
-
124
-
125
-
:code:`name`
126
-
--------------
127
-
128
-
The name of the MongoDB database you are going to store optimization data in. port and host must also be specified.
129
-
130
-
**Examples**
131
-
132
-
.. code-block:: python
133
-
134
-
# name should be a string
135
-
name ="my_db"
136
-
137
-
138
-
139
-
:code:`lpad`
99
+
:code:`launchpad`
140
100
--------------
141
101
142
102
A FireWorks launchpad object. Used in lieu of host, port, and name.
@@ -688,9 +648,3 @@ your problem is most likely with the timeout setting.
688
648
689
649
690
650
691
-
=======================================
692
-
Auto configure
693
-
=======================================
694
-
695
-
If you just have an expensive python function you'd like to put in a workflow, and not a complex workflow itself, don't forget auto_setup!
696
-
See the :doc:`quickstart </quickstart>` for more information on auto_setup.
0 commit comments