Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feat/ocm/random params #2231

Merged
merged 248 commits into from
Dec 9, 2021
Merged

Feat/ocm/random params #2231

merged 248 commits into from
Dec 9, 2021

Conversation

jdcpni
Copy link
Collaborator

@jdcpni jdcpni commented Dec 9, 2021

• composition.py
  - add random_variable property that returns all Components with seed Parameters
• optimizationcontrolmechanism.py:
  - add random_variable that allows Components to be specified for randomization across num_estimates

@jdcpni
• component.py
064d63f 
  docstring mod to **size**
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
614a53a 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
a32f213 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
75cf069 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
dff1a37 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
cd5e38e 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
9361857 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
0129ff7 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
bbd20f5 
…Link into devel
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
f9aba91 
…Link into devel
@jdcpni
• optimizationcontrolmechanism.py:
a3c0f6c 
  added feature_input_ports attribute and num_feature_input_ports property
@jdcpni
• optimizationcontrolmechanism.py:
7069b3a 
  added feature_input_ports attribute and num_feature_input_ports property

• parameterestimationcomposition.py: fixed misplacement of its Parameters() attribute
@jdcpni
• optimizationcontrolmechanism.py:
65b960e 
  added feature_input_ports attribute and num_feature_input_ports property

• parameterestimationcomposition.py: fixed misplacement of its Parameters() attribute

• optimizationfunctions.py: made num_estimates a Parameter
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
5cc58f6 
…Link into feat/ocm/feature_input_ports
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
bc05b51 
…Link into devel
@jdcpni
- modified test_mode_based_num_estimates
a8d428b
@jdcpni
-
1218b6f
@jdcpni
-
41567bb
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
b65650f 
…Link into feat/ocm/feature_input_ports
@jdcpni
• optimizationcontrolmechanism.py:
822742f 
  - _instantiate_control_signals: random_seeds -> random_seed_mod_values
@jdcpni
• composition.py
5a3efba 
  - _add_controller:  modifying to instantiate feature_input_ports if none are specified
@jdcpni
• composition.py:
7acdebd 
  - add_controller:  now adds feature_input_ports for Compostion INPUT nodes if not state_features not specified
@jdcpni
-
f81baf5
@jdcpni
• composition.py
cc1e98e 
  - _add_controller:  modifying to instantiate feature_input_ports if none are specified
@jdcpni
• composition.py:
a00b95f 
  - add_controller:  assign simulation_input_ports
@jdcpni
-
ed0a720
@jdcpni
• optimizationcontrolmechanism.py:
cb0b930 
  - feature_input_ports -> state_input_ports
  - _instantiate_input_ports():
      state_features only allowed to specifying state_input_ports if
      agent_rep is a CompositionFunctionApproximator (i.e., model-free optimization)

• composition.py:
  - add_controller: adds state_input_ports to shadow INPUT Nodes of Composition
    if controller.agent_rep is Composition (model-based optimziation)
    or state_features have not been specified (for model-free optimizaton)
@jdcpni
-
8cadf24
@jdcpni
• optimizationcontrolmechanism.py:
1cc216e 
  _instantiate_input_ports:
     reinstate allowance of state_features specification if agent_rep is a Composition
     (i.e., model-based optimization) as long as they are all INPUT Nodes of agent_rep
@jdcpni
-
ba278c1
@jdcpni
-
09cb615
@jdcpni
-
c6f3dcf
@jdcpni
Merge branch 'devel' into docs/ocm/revs
956c4ce
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
f26bd5c 
…Link into docs/ocm/revs
@jdcpni
-
e025314
@jdcpni
Merge branch 'docs/ocm/revs' of https://github.com/PrincetonUniversit…
26c33dc 
…y/PsyNeuLink into docs/ocm/revs
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
03ce8ee 
…Link into docs/ocm/revs

� Conflicts:
�	psyneulink/core/components/mechanisms/modulatory/control/optimizationcontrolmechanism.py
@jdcpni
• optimizationcontrolmechanism.py - more docstring edits
17ade6d
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
02fbf12 
…Link into docs/ocm/revs
@jdcpni
• optimizationcontrolmechanism.py - more docstring edits
d2cd4ca
@jdcpni
-
260d490
@jdcpni
-
d28443f
@jdcpni
-
e9dbfef
@jdcpni
-
e9a8fbd
@jdcpni
-
1a4b63d
@jdcpni
Merge branch 'docs/ocm/revs' of https://github.com/PrincetonUniversit…
d2a8eda 
…y/PsyNeuLink into docs/ocm/revs

� Conflicts:
�	psyneulink/core/components/mechanisms/modulatory/control/optimizationcontrolmechanism.py
@jdcpni
-
e5143e7
@jdcpni
• optimizationcontrolmechanism.py: add random_params
ee77e7f
@jdcpni
-
f46eaaa
@jdcpni
-
6654cb0
@jdcpni
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
afc8cc1 
…Link into feat/ocm/random_params
@jdcpni
-
368dac4
@jdcpni
-
590c9f2
@jdcpni
• composition.py
b8d32a2 
  - add random_variable property that returns all Components with seed Parameters
• optimizationcontrolmechanism.py:
  - add random_variable that allows Components to be specified for randomization across num_estimates
@github-actions
Copy link

github-actions bot commented Dec 9, 2021

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

diff -r docs-base/Composition.html docs-head/Composition.html
815c815
< <figure class="align-default" id="id17">
---
> <figure class="align-default" id="id18">
822c822
< and in italics, above each Mechanism).</span><a class="headerlink" href="#id17" title="Permalink to this image">¶</a></p>
---
> and in italics, above each Mechanism).</span><a class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
849c849
< <figure class="align-default" id="id18">
---
> <figure class="align-default" id="id19">
858c858
< one that projects to the ComparatorMechanism and assigned as the <a class="reference internal" href="#psyneulink.core.compositions.composition.NodeRole.OUTPUT" title="psyneulink.core.compositions.composition.NodeRole.OUTPUT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">OUTPUT</span></code></a> Node.</span><a class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
---
> one that projects to the ComparatorMechanism and assigned as the <a class="reference internal" href="#psyneulink.core.compositions.composition.NodeRole.OUTPUT" title="psyneulink.core.compositions.composition.NodeRole.OUTPUT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">OUTPUT</span></code></a> Node.</span><a class="headerlink" href="#id19" title="Permalink to this image">¶</a></p>
876c876
< <figure class="align-default" id="id19">
---
> <figure class="align-default" id="id20">
880c880
< method with the argument <code class="docutils literal notranslate"><span class="pre">animate={'show_learning':True}</span></code>.</span><a class="headerlink" href="#id19" title="Permalink to this image">¶</a></p>
---
> method with the argument <code class="docutils literal notranslate"><span class="pre">animate={'show_learning':True}</span></code>.</span><a class="headerlink" href="#id20" title="Permalink to this image">¶</a></p>
1050c1050
< <figure class="align-default" id="id20">
---
> <figure class="align-default" id="id21">
1058c1058
< Mechanism <code class="docutils literal notranslate"><span class="pre">c</span></code> on every <a class="reference internal" href="Time.html#psyneulink.core.scheduling.time.TimeScale.TRIAL" title="psyneulink.core.scheduling.time.TimeScale.TRIAL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">TRIAL</span></code></a>.</span><a class="headerlink" href="#id20" title="Permalink to this image">¶</a></p>
---
> Mechanism <code class="docutils literal notranslate"><span class="pre">c</span></code> on every <a class="reference internal" href="Time.html#psyneulink.core.scheduling.time.TimeScale.TRIAL" title="psyneulink.core.scheduling.time.TimeScale.TRIAL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">TRIAL</span></code></a>.</span><a class="headerlink" href="#id21" title="Permalink to this image">¶</a></p>
2396a2397,2411
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.random_variables">
> <span class="sig-name descname"><span class="pre">random_variables</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.random_variables" title="Permalink to this definition">¶</a></dt>
> <dd><p>list of Components in Composition with variables that call a randomization function
> .. technical_note:</p>
> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>These are Components with a seed `Parameter`.
> </pre></div>
> </div>
> <dl class="field-list simple">
> <dt class="field-odd">Type</dt>
> <dd class="field-odd"><p>list[<a class="reference internal" href="Component.html#psyneulink.core.components.component.Component" title="psyneulink.core.components.component.Component">Component</a>]</p>
> </dd>
> </dl>
> </dd></dl>
> 
> <dl class="py attribute">
4332a4348,4353
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.output_port">
> <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">output_port</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.output_port" title="Permalink to this definition">¶</a></dt>
> <dd><p>Return the index 0 OutputPort that belongs to the Output CompositionInterfaceMechanism</p>
> </dd></dl>
> 
> <dl class="py property">
4386,4391d4406
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.output_port">
< <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">output_port</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.output_port" title="Permalink to this definition">¶</a></dt>
< <dd><p>Return the index 0 OutputPort that belongs to the Output CompositionInterfaceMechanism</p>
< </dd></dl>
< 
< <dl class="py property">
4395a4411,4416
> </dd></dl>
> 
> <dl class="py property">
> <dt class="sig sig-object py" id="id17">
> <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">random_variables</span></span><a class="headerlink" href="#id17" title="Permalink to this definition">¶</a></dt>
> <dd><p>Return Components with seed Parameters (that is, ones that that call a randomization function.</p>
diff -r docs-base/ModulatoryMechanism.html docs-head/ModulatoryMechanism.html
237c237
< <a class="reference internal" href="OutputPort.html"><span class="doc">OutputPorts</span></a> that appear after its ControlSignals in its <code class="xref any docutils literal notranslate"><span class="pre">output_ports</span></code> attribute.</p>
---
> <a class="reference internal" href="OutputPort.html"><span class="doc">OutputPorts</span></a> that appear after its ControlSignals in its <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_ports" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_ports"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_ports</span></code></a> attribute.</p>
diff -r docs-base/OptimizationControlMechanism.html docs-head/OptimizationControlMechanism.html
204,205c204
< <blockquote>
< <div><ul>
---
> <ul class="simple">
207c206
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-overview"><span class="std std-ref">Overview</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-overview"><span class="std std-ref">Overview</span></a></dt><dd><ul>
222c221
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-creation"><span class="std std-ref">Creating an OptimizationControlMechanism</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-creation"><span class="std std-ref">Creating an OptimizationControlMechanism</span></a></dt><dd><ul>
231c230
< <li><dl>
---
> <li><dl class="simple">
233,239c232,243
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-agent-rep"><span class="std std-ref">Agent Representation</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-state"><span class="std std-ref">State</span></a></p></li>
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-input"><span class="std std-ref">Input</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-state-features"><span class="std std-ref">state_input_ports</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-outcome"><span class="std std-ref">outcome_input_ports</span></a></p>
< <blockquote>
< <div><ul class="simple">
---
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-agent-rep"><span class="std std-ref">Agent Representation</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-state"><span class="std std-ref">State</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-input"><span class="std std-ref">Input</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-state-features"><span class="std std-ref">state_input_ports</span></a></p></li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-outcome"><span class="std std-ref">outcome_input_ports</span></a></dt><dd><ul>
244c248,253
< </div></blockquote>
---
> </dd>
> </dl>
> </li>
> </ul>
> </dd>
> </dl>
247c256,257
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-function"><span class="std std-ref">Function</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-function"><span class="std std-ref">Function</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-custom-function"><span class="std std-ref">Custom Function</span></a></p></li>
248a259,266
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-default-function"><span class="std std-ref">Default Function: GridSearch</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-output"><span class="std std-ref">Output</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-randomization-control-signal"><span class="std std-ref">Randomization ControlSignal</span></a></p></li>
257c275,282
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-execution"><span class="std std-ref">Execution</span></a></p></li>
---
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-execution"><span class="std std-ref">Execution</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-optimization-procedure"><span class="std std-ref">Optimization Procedure</span></a></p></li>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-estimation-randomization"><span class="std std-ref">Randomization of Estimation</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
260d284
< </div></blockquote>
311c335
< <figure class="align-default" id="id7">
---
> <figure class="align-default" id="id3">
320c344
< faded items show process of adaptation when using a <a class="reference internal" href="CompositionFunctionApproximator.html"><span class="doc">CompositionFunctionApproximator</span></a> as the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">agent_rep</span></code></a>.</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
---
> faded items show process of adaptation when using a <a class="reference internal" href="CompositionFunctionApproximator.html"><span class="doc">CompositionFunctionApproximator</span></a> as the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">agent_rep</span></code></a>.</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
335c359,360
< <div class="admonition note">
---
> <blockquote>
> <div><div class="admonition note">
342a368
> </div></blockquote>
387c413,414
< <div class="admonition note" id="optimizationcontrolmechanism-state-features-shapes">
---
> <blockquote id="optimizationcontrolmechanism-state-features-shapes">
> <div><div class="admonition note">
405a433
> </div></blockquote>
412c440,441
< <div class="admonition warning">
---
> <blockquote>
> <div><div class="admonition warning">
419a449
> </div></blockquote>
468c498
< <li><p><em>Outcome arguments</em> – these specify the Components, the values of which are assigned to the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">outcome</span></code></a> attribute, and used to compute the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> for a
---
> <li><p><strong>Outcome arguments</strong> – these specify the Components, the values of which are assigned to the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">outcome</span></code></a> attribute, and used to compute the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> for a
492c522
< <li><p><em>Optimization arguments</em> – these specify parameters that determine how the OptimizationControlMechanism’s
---
> <li><p><strong>Optimization arguments</strong> – these specify parameters that determine how the OptimizationControlMechanism’s
494,495c524,527
< of the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_estimates" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_estimates"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">num_estimates</span></code></a> and <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_trials_per_estimate" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_trials_per_estimate"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">num_trials_per_estimate</span></code></a> parameters, which determine how the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> is estimated for a given <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.control_allocation" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.control_allocation"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">control_allocation</span></code></a>
< (see <a class="refer
...

See CI logs for the full diff.

@github-actions
Copy link

github-actions bot commented Dec 9, 2021

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

diff -r docs-base/Composition.html docs-head/Composition.html
815c815
< <figure class="align-default" id="id17">
---
> <figure class="align-default" id="id18">
822c822
< and in italics, above each Mechanism).</span><a class="headerlink" href="#id17" title="Permalink to this image">¶</a></p>
---
> and in italics, above each Mechanism).</span><a class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
849c849
< <figure class="align-default" id="id18">
---
> <figure class="align-default" id="id19">
858c858
< one that projects to the ComparatorMechanism and assigned as the <a class="reference internal" href="#psyneulink.core.compositions.composition.NodeRole.OUTPUT" title="psyneulink.core.compositions.composition.NodeRole.OUTPUT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">OUTPUT</span></code></a> Node.</span><a class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
---
> one that projects to the ComparatorMechanism and assigned as the <a class="reference internal" href="#psyneulink.core.compositions.composition.NodeRole.OUTPUT" title="psyneulink.core.compositions.composition.NodeRole.OUTPUT"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">OUTPUT</span></code></a> Node.</span><a class="headerlink" href="#id19" title="Permalink to this image">¶</a></p>
876c876
< <figure class="align-default" id="id19">
---
> <figure class="align-default" id="id20">
880c880
< method with the argument <code class="docutils literal notranslate"><span class="pre">animate={'show_learning':True}</span></code>.</span><a class="headerlink" href="#id19" title="Permalink to this image">¶</a></p>
---
> method with the argument <code class="docutils literal notranslate"><span class="pre">animate={'show_learning':True}</span></code>.</span><a class="headerlink" href="#id20" title="Permalink to this image">¶</a></p>
1050c1050
< <figure class="align-default" id="id20">
---
> <figure class="align-default" id="id21">
1058c1058
< Mechanism <code class="docutils literal notranslate"><span class="pre">c</span></code> on every <a class="reference internal" href="Time.html#psyneulink.core.scheduling.time.TimeScale.TRIAL" title="psyneulink.core.scheduling.time.TimeScale.TRIAL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">TRIAL</span></code></a>.</span><a class="headerlink" href="#id20" title="Permalink to this image">¶</a></p>
---
> Mechanism <code class="docutils literal notranslate"><span class="pre">c</span></code> on every <a class="reference internal" href="Time.html#psyneulink.core.scheduling.time.TimeScale.TRIAL" title="psyneulink.core.scheduling.time.TimeScale.TRIAL"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">TRIAL</span></code></a>.</span><a class="headerlink" href="#id21" title="Permalink to this image">¶</a></p>
2396a2397,2410
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.random_variables">
> <span class="sig-name descname"><span class="pre">random_variables</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.random_variables" title="Permalink to this definition">¶</a></dt>
> <dd><p>list of Components in Composition with variables that call a randomization function.</p>
> <div class="technical-note docutils container">
> <p>These are Components with a seed <a class="reference internal" href="Parameters.html#psyneulink.core.globals.parameters.Parameter" title="psyneulink.core.globals.parameters.Parameter"><code class="xref any py py-class docutils literal notranslate"><span class="pre">Parameter</span></code></a>.</p>
> </div>
> <dl class="field-list simple">
> <dt class="field-odd">Type</dt>
> <dd class="field-odd"><p>list[<a class="reference internal" href="Component.html#psyneulink.core.components.component.Component" title="psyneulink.core.components.component.Component">Component</a>]</p>
> </dd>
> </dl>
> </dd></dl>
> 
> <dl class="py attribute">
4332a4347,4352
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.output_port">
> <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">output_port</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.output_port" title="Permalink to this definition">¶</a></dt>
> <dd><p>Return the index 0 OutputPort that belongs to the Output CompositionInterfaceMechanism</p>
> </dd></dl>
> 
> <dl class="py property">
4386,4391d4405
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.output_port">
< <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">output_port</span></span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.output_port" title="Permalink to this definition">¶</a></dt>
< <dd><p>Return the index 0 OutputPort that belongs to the Output CompositionInterfaceMechanism</p>
< </dd></dl>
< 
< <dl class="py property">
4395a4410,4415
> </dd></dl>
> 
> <dl class="py property">
> <dt class="sig sig-object py" id="id17">
> <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">random_variables</span></span><a class="headerlink" href="#id17" title="Permalink to this definition">¶</a></dt>
> <dd><p>Return list of Components with seed Parameters (i.e., ones that that call a random function).</p>
diff -r docs-base/ModulatoryMechanism.html docs-head/ModulatoryMechanism.html
237c237
< <a class="reference internal" href="OutputPort.html"><span class="doc">OutputPorts</span></a> that appear after its ControlSignals in its <code class="xref any docutils literal notranslate"><span class="pre">output_ports</span></code> attribute.</p>
---
> <a class="reference internal" href="OutputPort.html"><span class="doc">OutputPorts</span></a> that appear after its ControlSignals in its <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_ports" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_ports"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_ports</span></code></a> attribute.</p>
diff -r docs-base/OptimizationControlMechanism.html docs-head/OptimizationControlMechanism.html
204,205c204
< <blockquote>
< <div><ul>
---
> <ul class="simple">
207c206
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-overview"><span class="std std-ref">Overview</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-overview"><span class="std std-ref">Overview</span></a></dt><dd><ul>
222c221
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-creation"><span class="std std-ref">Creating an OptimizationControlMechanism</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-creation"><span class="std std-ref">Creating an OptimizationControlMechanism</span></a></dt><dd><ul>
231c230
< <li><dl>
---
> <li><dl class="simple">
233,239c232,243
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-agent-rep"><span class="std std-ref">Agent Representation</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-state"><span class="std std-ref">State</span></a></p></li>
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-input"><span class="std std-ref">Input</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-state-features"><span class="std std-ref">state_input_ports</span></a>
< - <a class="reference internal" href="#optimizationcontrolmechanism-outcome"><span class="std std-ref">outcome_input_ports</span></a></p>
< <blockquote>
< <div><ul class="simple">
---
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-agent-rep"><span class="std std-ref">Agent Representation</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-state"><span class="std std-ref">State</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-input"><span class="std std-ref">Input</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-state-features"><span class="std std-ref">state_input_ports</span></a></p></li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-outcome"><span class="std std-ref">outcome_input_ports</span></a></dt><dd><ul>
244c248,253
< </div></blockquote>
---
> </dd>
> </dl>
> </li>
> </ul>
> </dd>
> </dl>
247c256,257
< <dt><a class="reference internal" href="#optimizationcontrolmechanism-function"><span class="std std-ref">Function</span></a></dt><dd><ul class="simple">
---
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-function"><span class="std std-ref">Function</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-custom-function"><span class="std std-ref">Custom Function</span></a></p></li>
248a259,266
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-default-function"><span class="std std-ref">Default Function: GridSearch</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-output"><span class="std std-ref">Output</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-randomization-control-signal"><span class="std std-ref">Randomization ControlSignal</span></a></p></li>
257c275,282
< <li><p><a class="reference internal" href="#optimizationcontrolmechanism-execution"><span class="std std-ref">Execution</span></a></p></li>
---
> <li><dl class="simple">
> <dt><a class="reference internal" href="#optimizationcontrolmechanism-execution"><span class="std std-ref">Execution</span></a></dt><dd><ul>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-optimization-procedure"><span class="std std-ref">Optimization Procedure</span></a></p></li>
> <li><p><a class="reference internal" href="#optimizationcontrolmechanism-estimation-randomization"><span class="std std-ref">Randomization of Estimation</span></a></p></li>
> </ul>
> </dd>
> </dl>
> </li>
260d284
< </div></blockquote>
311c335
< <figure class="align-default" id="id7">
---
> <figure class="align-default" id="id3">
320c344
< faded items show process of adaptation when using a <a class="reference internal" href="CompositionFunctionApproximator.html"><span class="doc">CompositionFunctionApproximator</span></a> as the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">agent_rep</span></code></a>.</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
---
> faded items show process of adaptation when using a <a class="reference internal" href="CompositionFunctionApproximator.html"><span class="doc">CompositionFunctionApproximator</span></a> as the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.agent_rep"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">agent_rep</span></code></a>.</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
335c359,360
< <div class="admonition note">
---
> <blockquote>
> <div><div class="admonition note">
342a368
> </div></blockquote>
387c413,414
< <div class="admonition note" id="optimizationcontrolmechanism-state-features-shapes">
---
> <blockquote id="optimizationcontrolmechanism-state-features-shapes">
> <div><div class="admonition note">
405a433
> </div></blockquote>
412c440,441
< <div class="admonition warning">
---
> <blockquote>
> <div><div class="admonition warning">
419a449
> </div></blockquote>
468c498
< <li><p><em>Outcome arguments</em> – these specify the Components, the values of which are assigned to the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">outcome</span></code></a> attribute, and used to compute the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> for a
---
> <li><p><strong>Outcome arguments</strong> – these specify the Components, the values of which are assigned to the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">outcome</span></code></a> attribute, and used to compute the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> for a
492c522
< <li><p><em>Optimization arguments</em> – these specify parameters that determine how the OptimizationControlMechanism’s
---
> <li><p><strong>Optimization arguments</strong> – these specify parameters that determine how the OptimizationControlMechanism’s
494,495c524,527
< of the <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_estimates" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_estimates"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">num_estimates</span></code></a> and <a class="reference internal" href="#psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_trials_per_estimate" title="psyneulink.core.components.mechanisms.modulatory.control.optimizationcontrolmechanism.OptimizationControlMechanism.num_trials_per_estimate"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">num_trials_per_estimate</span></code></a> parameters, which determine how the <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome" title="psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.net_outcome"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">net_outcome</span></code></a> is estimated for a given <a class="reference internal" href="ControlMechanism.html#psyneulink.core.components.mechanisms.modulatory.control.controlmechanism.ControlMechanism.control_allocation" title="psyneulink.core.components.mechanisms.modulatory.control.controlm
...

See CI logs for the full diff.

@coveralls
Copy link

coveralls commented Dec 9, 2021 •
edited
Loading

Coverage Status

Coverage decreased (-0.005%) to 83.879% when pulling 2431b9c on feat/ocm/random_params into d34bff3 on devel.

@jdcpni jdcpni merged commit 2937a92 into devel Dec 9, 2021
@jdcpni jdcpni deleted the feat/ocm/random_params branch December 9, 2021 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jdcpni @coveralls @jvesely @kmantel