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.

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

Feat/comp/inputs #2257

Merged
merged 358 commits into from
Dec 23, 2021
Merged

Feat/comp/inputs #2257

merged 358 commits into from
Dec 23, 2021

Conversation

jdcpni
Copy link
Collaborator

@jdcpni jdcpni commented Dec 21, 2021

• composition

  • get_results_by_node -> get_results_by_nodes
  • get_results_by_nodes: add nodes argument (specifies one or more nodes to select)
    • mechanism.py:
  • add input_labels and output_labels as args to constructor

jdcpni and others added 30 commits November 20, 2021 17:00
  _instantiate_control_projections:
     weird requirement for double-call to controller._instantiate_control_signal
  restored parameter spec that causes crash ('threshold',Decision2)
…trol specs

- composition.py
  - _get_control_signals_for_composition:  (see 11/20/21)
      - added (but commented out change) to "if node.controller" to "if not node.controller"
      - changed append to extend
  - _instantiation_control_projection:
      - got rid of try and except double-call to controller._instantiate_control_signals
      -  outdented call to self.controller._activate_projections_for_composition at end

- controlmechanism.py:
    - _check_for_duplicates:  add warning and return duplicates

- optimizationcontrolmechanism._instantiate_control_signals:
    - add call to self.agent_rep._get_control_signals_for_composition() to get local control specs (on mechs in comp)
    - eliminate duplicates with control_signal specs on OCM
    - instantiate local + ocm control_signals

- parameterestimationcomposition.py
  - added context to various calls
   - test_parameterestimationcomposition
   - test_composition/test_partially_overlapping_control_specs (ADDED IN THIS COMMINT)

- All relevant changes to this branch are marked as "11/21/21."
  However, most are commented out as they break other things.

- The tests above both involve local control specifications (on mechanism within a nested comp)
  and on the OCM for the outer composition, some of which are for the same nested mechs

- Both tests fail with:
   "AttributeError: 'NoneType' object has no attribute '_get_by_time_scale'" (in component.py LINE 3276)
   This may be due to a problem with context setting, since the error is because the modulation Parameter
   of the ControlProjection is returning "None" rather than "multiplicative_param" (when called with get(context)),
   whereas "multiplicative_param" is returned with a call to get() (i.e., with no context specified)

- Most of test_partially_overlapping_control_specs is passed if
   changes marked "11/21/21 NEW" in optimizationcontrolmechanism.py (LINE 1390) are implemented,
   but it does not properly route ControlProjections through parameter_CIMS (see last assert in test).
   Furthermore, test_parameterestimationcompsition fails with the mod param error, even though the
   model has similar structure (i.e., outer composition -- in this case a ParameterEstimationComposition)
   with an OCM that is given control specs that overlap with ones in a nested composition.

- There are also several other things in composition I found puzzling and tried modifying, but that cuased failures:
  - _get_control_signals_for_composition():
      - seems "if node.controller" should be "if **not** node.controller" (emphasis added just for comment)
      - "append" should be "extend"
  - _instantiate_control_projection():
      -  call to self.controller._activate_projections_for_composition (at end of method) should not be indented
  - rename _check_projection_initialization_status -> _check_controller_initialization_status
  - add _check_nodes_initialization_status(context=context)
    (and calls it with _check_controller_initialization_status)
  retore append of control_signals in _instantiate_control_projections()
  restore append of control_signals in _instantiate_control_projections()

• test_composition.py:
  add test_partially_overlapping_local_and_control_mech_control_specs_in_unnested_and_nested_comp
…unnested_and_nested_comp():

  - added clear_registry() to allow names to be reused in both runs of test
  docstring:  added projections entry to list of attributes
  - add_controller:  added call to _add_node_aux_components() for controller
  _add_node_aux_components(): added deletion of item from aux_components if instantiated
  - comment out _add_node_aux_components() (causing new failures)
  - move _instantiate_control_projections to be with _instantiate_control_projections,
       after self.add_node(self.controller.objective_mechanism (to be more orderly)
…rtially_overlapping...

  (with addition of _add_aux_components in add_controller commented out)
  - get_results_by_nodes: allow specification of individual nodes
  - get_results_by_nodes: allow specification of individual nodes
  - get_results_by_nodes: allow specification of individual nodes
…sity/PsyNeuLink into feat/comp/inputs

� Conflicts:
�	psyneulink/core/compositions/composition.py
@github-actions
Copy link

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
1661,1664c1661,1665
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4548
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4566,4567
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4569,4573
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4577,4582
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
4594c4586
< <dd class="field-even"><p><strong>Mechanism’s output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
---
> <dd class="field-even"><p><strong>Node output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
diff -r docs-base/genindex.html docs-head/genindex.html
2224a2225,2226
>   </ul></td>
>   <td style="width: 33%; vertical-align: top;"><ul>
2229,2230d2230
<   </ul></td>
<   <td style="width: 33%; vertical-align: top;"><ul>
2251,2252d2250
<       <li><a href="Composition.html#psyneulink.core.compositions.composition.Composition.get_output_format">get_output_format() (psyneulink.core.compositions.composition.Composition method)</a>
< </li>
2265,2269c2263
<       <li><a href="Composition.html#psyneulink.core.compositions.composition.Composition.get_result_format">get_result_format() (psyneulink.core.compositions.composition.Composition method)</a>
< </li>
<       <li><a href="Co
...

See CI logs for the full diff.

1 similar comment
@github-actions
Copy link

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
1661,1664c1661,1665
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4548
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4566,4567
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4569,4573
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4577,4582
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
4594c4586
< <dd class="field-even"><p><strong>Mechanism’s output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
---
> <dd class="field-even"><p><strong>Node output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
diff -r docs-base/genindex.html docs-head/genindex.html
2224a2225,2226
>   </ul></td>
>   <td style="width: 33%; vertical-align: top;"><ul>
2229,2230d2230
<   </ul></td>
<   <td style="width: 33%; vertical-align: top;"><ul>
2251,2252d2250
<       <li><a href="Composition.html#psyneulink.core.compositions.composition.Composition.get_output_format">get_output_format() (psyneulink.core.compositions.composition.Composition method)</a>
< </li>
2265,2269c2263
<       <li><a href="Composition.html#psyneulink.core.compositions.composition.Composition.get_result_format">get_result_format() (psyneulink.core.compositions.composition.Composition method)</a>
< </li>
<       <li><a href="Co
...

See CI logs for the full diff.

  add input_labels and output_labels as args to constructor
@coveralls
Copy link

coveralls commented Dec 22, 2021

Coverage Status

Coverage increased (+0.1%) to 84.281% when pulling edf2fc9 on feat/comp/inputs into 47abfd9 on devel.

@github-actions
Copy link

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
1661,1664c1661,1665
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4548
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4566,4567
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4569,4573
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4577,4582
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
4594c4586
< <dd class="field-even"><p><strong>Mechanism’s output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
---
> <dd class="field-even"><p><strong>Node output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
diff -r docs-base/Mechanism.html docs-head/Mechanism.html
663a664,667
> <li><p><strong>input_labels</strong> / <em>INPUT_LABEL_DICTS</em> - a dict specifying labels that can be used as inputs
> (see <a class="reference internal" href="#mechanism-labels-dicts"><span class="std std-ref">Value Label Dictionaries</span></a> for details of specification).</p></li>
> </ul>
> <ul class="simple">
667a672,675
> <li><p><strong>output_labels</strong> / <em>OUTPUT_LABEL_DICTS</em> - a dict specifying labels that can be for reporting outputs
> (see <a class="reference internal" href="#mechanism-labels-dicts"><span class="std std-ref">Value Label Dictionaries</span></a> for details of speci
...

See CI logs for the full diff.

1 similar comment
@github-actions
Copy link

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
1661,1664c1661,1665
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4548
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4566,4567
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4569,4573
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4577,4582
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
4594c4586
< <dd class="field-even"><p><strong>Mechanism’s output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
---
> <dd class="field-even"><p><strong>Node output_values</strong> – dict , the keys of which are either Mechanisms or the names of them, and values are their
diff -r docs-base/Mechanism.html docs-head/Mechanism.html
663a664,667
> <li><p><strong>input_labels</strong> / <em>INPUT_LABEL_DICTS</em> - a dict specifying labels that can be used as inputs
> (see <a class="reference internal" href="#mechanism-labels-dicts"><span class="std std-ref">Value Label Dictionaries</span></a> for details of specification).</p></li>
> </ul>
> <ul class="simple">
667a672,675
> <li><p><strong>output_labels</strong> / <em>OUTPUT_LABEL_DICTS</em> - a dict specifying labels that can be for reporting outputs
> (see <a class="reference internal" href="#mechanism-labels-dicts"><span class="std std-ref">Value Label Dictionaries</span></a> for details of speci
...

See CI logs for the full diff.

@github-actions
Copy link

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
938,939c938
< <a class="reference internal image-reference" href="_images/Composition_Multilayer_Learning_fig.svg"><img alt="Schematic of LearningMechanism and LearningProjections in a Process" height="7536" src="_images/Composition_Multilayer_Learning_fig.svg" width="6380" /></a>
< <figcaption>
---
> <img alt="Schematic of LearningMechanism and LearningProjections in a Process" src="_images/Composition_Multilayer_Learning_fig.svg" /><figcaption>
972,973c971
< <a class="reference internal image-reference" href="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg"><img alt="Schematic of Mechanisms and Projections involved in learning" height="6072" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" width="6679" /></a>
< <figcaption>
---
> <img alt="Schematic of Mechanisms and Projections involved in learning" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" /><figcaption>
999c997
< <a class="reference internal image-reference" href="_images/Composition_XOR_animation.gif"><img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" style="width: 328.5px; height: 401.5px;" /></a>
---
> <img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" />
1661,1664c1659,1663
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4546
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4564,4565
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4567,4571
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4575,4580
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_
...

See CI logs for the full diff.

@github-actions
Copy link

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
938,939c938
< <a class="reference internal image-reference" href="_images/Composition_Multilayer_Learning_fig.svg"><img alt="Schematic of LearningMechanism and LearningProjections in a Process" height="7536" src="_images/Composition_Multilayer_Learning_fig.svg" width="6380" /></a>
< <figcaption>
---
> <img alt="Schematic of LearningMechanism and LearningProjections in a Process" src="_images/Composition_Multilayer_Learning_fig.svg" /><figcaption>
972,973c971
< <a class="reference internal image-reference" href="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg"><img alt="Schematic of Mechanisms and Projections involved in learning" height="6072" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" width="6679" /></a>
< <figcaption>
---
> <img alt="Schematic of Mechanisms and Projections involved in learning" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" /><figcaption>
999c997
< <a class="reference internal image-reference" href="_images/Composition_XOR_animation.gif"><img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" style="width: 328.5px; height: 401.5px;" /></a>
---
> <img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" />
1661,1664c1659,1663
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4546
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4564,4565
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4567,4571
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4575,4580
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_
...

See CI logs for the full diff.

@github-actions
Copy link

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
938,939c938
< <a class="reference internal image-reference" href="_images/Composition_Multilayer_Learning_fig.svg"><img alt="Schematic of LearningMechanism and LearningProjections in a Process" height="7536" src="_images/Composition_Multilayer_Learning_fig.svg" width="6380" /></a>
< <figcaption>
---
> <img alt="Schematic of LearningMechanism and LearningProjections in a Process" src="_images/Composition_Multilayer_Learning_fig.svg" /><figcaption>
972,973c971
< <a class="reference internal image-reference" href="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg"><img alt="Schematic of Mechanisms and Projections involved in learning" height="6072" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" width="6679" /></a>
< <figcaption>
---
> <img alt="Schematic of Mechanisms and Projections involved in learning" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" /><figcaption>
999c997
< <a class="reference internal image-reference" href="_images/Composition_XOR_animation.gif"><img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" style="width: 328.5px; height: 401.5px;" /></a>
---
> <img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" />
1661,1664c1659,1663
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4546
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4564,4565
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4567,4571
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4575,4580
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_
...

See CI logs for the full diff.

@github-actions
Copy link

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
938,939c938
< <a class="reference internal image-reference" href="_images/Composition_Multilayer_Learning_fig.svg"><img alt="Schematic of LearningMechanism and LearningProjections in a Process" height="7536" src="_images/Composition_Multilayer_Learning_fig.svg" width="6380" /></a>
< <figcaption>
---
> <img alt="Schematic of LearningMechanism and LearningProjections in a Process" src="_images/Composition_Multilayer_Learning_fig.svg" /><figcaption>
972,973c971
< <a class="reference internal image-reference" href="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg"><img alt="Schematic of Mechanisms and Projections involved in learning" height="6072" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" width="6679" /></a>
< <figcaption>
---
> <img alt="Schematic of Mechanisms and Projections involved in learning" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" /><figcaption>
999c997
< <a class="reference internal image-reference" href="_images/Composition_XOR_animation.gif"><img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" style="width: 328.5px; height: 401.5px;" /></a>
---
> <img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" />
1661,1664c1659,1663
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4546
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4564,4565
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_node">
< <span class="sig-name descname"><span class="pre">get_results_by_node</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="Permalink to this definition">¶</a></dt>
---
> <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_by_nodes">
> <span class="sig-name descname"><span class="pre">get_results_by_nodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="Permalink to this definition">¶</a></dt>
4585a4567,4571
> <div class="admonition note">
> <p class="admonition-title">Note</p>
> <p>Items are listed in the order of their values in the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute,
> irrespective of the order in which they appear in the <strong>nodes</strong> argument if specified.</p>
> </div>
4589,4590c4575,4580
< <li><p><strong>use_names</strong> (<em>bool : False</em>) – if True, keys of dict are names of Mechanisms; else they are references to the Mechanisms themselves.</p></li>
< <li><p><strong>use_labels</strong> (<em>bool : False</em>) – if True, values are labels for Mechanisms that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_dict"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_labels_dict</span></code></a> attribute.</p></li>
---
> <li><p><strong>nodes</strong> (<em>List</em><em>[</em><em>Mechanism</em><em> or </em><em>str</em><em>]</em><em>, </em><em>Mechanism</em><em> or </em><em>str : default None</em>) – specifies <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> for which to report the value; can be a reference to a Mechanism,
> its name, or a list of either or both.  If None (the default), the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of
> all <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> Nodes are reported.</p></li>
> <li><p><strong>use_names</strong> (<em>bool : default False</em>) – specifies whether to use the names of <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a> rather than references to them as keys.</p></li>
> <li><p><strong>use_labels</strong> (<em>bool : default False</em>) – specifies whether to use labels to report the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.value"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">values</span></code></a> of Nodes for <code class="xref any docutils literal notranslate"><span class="pre">Mechanisms</span>
> <span class="pre">Mechanism</span></code> that have an <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_labels_
...

See CI logs for the full diff.

@github-actions
Copy link

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

diff -r docs-base/Compilation.html docs-head/Compilation.html
204c204,208
< The performance improvements varies, but it has been observed to be between one and three orders of magnitude depending on the model.</p>
---
> The performance improvements varies, but it has been observed to be between
> one and three orders of magnitude depending on the model.
> See <a class="reference external" href="http://www.cs.yale.edu/homes/abhishek/jvesely-cgo22.pdf">Vesely et al. (2022)</a>
> for additional information about the approach taken to compilation, and
> <a class="reference internal" href="Composition.html#composition-compilation"><span class="std std-ref">Compilation</span></a> for it use in executing a <a class="reference internal" href="Composition.html"><span class="doc">Composition</span></a>.</p>
diff -r docs-base/Composition.html docs-head/Composition.html
938,939c938
< <a class="reference internal image-reference" href="_images/Composition_Multilayer_Learning_fig.svg"><img alt="Schematic of LearningMechanism and LearningProjections in a Process" height="7536" src="_images/Composition_Multilayer_Learning_fig.svg" width="6380" /></a>
< <figcaption>
---
> <img alt="Schematic of LearningMechanism and LearningProjections in a Process" src="_images/Composition_Multilayer_Learning_fig.svg" /><figcaption>
972,973c971
< <a class="reference internal image-reference" href="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg"><img alt="Schematic of Mechanisms and Projections involved in learning" height="6072" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" width="6679" /></a>
< <figcaption>
---
> <img alt="Schematic of Mechanisms and Projections involved in learning" src="_images/Composition_Learning_OUTPUT_vs_TERMINAL_fig.svg" /><figcaption>
999c997
< <a class="reference internal image-reference" href="_images/Composition_XOR_animation.gif"><img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" style="width: 328.5px; height: 401.5px;" /></a>
---
> <img alt="Animation of Composition with learning" src="_images/Composition_XOR_animation.gif" />
1599,1609c1597,1605
< many cases, a Composition can also be executed in a compiled mode.  While this can add some time to initiate execution,
< execution itself can be several orders of magnitude faster than using the Python interpreter.  Thus, using a compiled
< mode can be useful for executing Compositions that are complex and/or for large numbers of <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>s.
< Compilation is supported for most CPUs (including x86, arm64, and powerpc64le).  Several modes can be specified, that
< that tradeoff power (i.e., degree of speed-up) against level of support (i.e., likelihood of success).  Most PsyNeuLink
< <a class="reference internal" href="Component.html"><span class="doc">Components</span></a> and methods are supported for compilation;  however, Python native functions and methods
< (e.g., used to specify the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.function" title="psyneulink.core.components.component.Component.function"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">function</span></code></a> of a Component) are not supported at present. Users who wish
< to compile custom functions should refer to <a class="reference internal" href="UserDefinedFunction.html"><span class="doc">compiled User Defined Functions</span></a> for more
< information.  Users are strongly urged to report any other compilation failures to
< <a class="reference external" href="mailto:psyneulinkhelp&#37;&#52;&#48;princeton&#46;edu">psyneulinkhelp<span>&#64;</span>princeton<span>&#46;</span>edu</a>, or as an issue <a class="reference external" href="https://github.com/PrincetonUniversity/PsyNeuLink/issues">here</a>.
< Known failure conditions are listed <a class="reference external" href="https://github.com/PrincetonUniversity/PsyNeuLink/milestone/2">here</a>.</p>
---
> many cases, a Composition can also be executed in a <a class="reference internal" href="Compilation.html"><span class="doc">compiled mode</span></a>.  While this can add some time to
> initiate execution, execution itself can be several orders of magnitude faster than using the Python interpreter. Thus,
> using a compiled mode can be useful for executing Compositions that are complex and/or for large numbers of <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>s. <a class="reference internal" href="Compilation.html"><span class="doc">Compilation</span></a> is supported for most CPUs (including x86, arm64, and powerpc64le).  Several modes
> can be specified, that that tradeoff power (i.e., degree of speed-up) against level of support (i.e., likelihood of
> success).  Most PsyNeuLink <a class="reference internal" href="Component.html"><span class="doc">Components</span></a> and methods are supported for compilation;  however, Python native
> functions and methods (e.g., used to specify the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.function" title="psyneulink.core.components.component.Component.function"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">function</span></code></a> of a Component) are not supported at
> present. Users who wish to compile custom functions should refer to <a class="reference internal" href="UserDefinedFunction.html"><span class="doc">compiled User Defined Functions</span></a> for more information.   See below and <a class="reference internal" href="Compilation.html"><span class="doc">Compilation</span></a> for additional details regarding the use
> of compiled modes of execution, and <a class="reference external" href="http://www.cs.yale.edu/homes/abhishek/jvesely-cgo22.pdf">Vesely et al. (2022)</a>
> for more information about the approach taken to compilation.</p>
1616a1613,1615
> <p>Users are strongly urged to report any compilation failures to <a class="reference external" href="mailto:psyneulinkhelp&#37;&#52;&#48;princeton&#46;edu">psyneulinkhelp<span>&#64;</span>princeton<span>&#46;</span>edu</a>, or as an
> issue <a class="reference external" href="https://github.com/PrincetonUniversity/PsyNeuLink/issues">here</a>. Known failure conditions are listed
> <a class="reference external" href="https://github.com/PrincetonUniversity/PsyNeuLink/milestone/2">here</a>.</p>
1661,1664c1660,1664
< <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added
< to the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for
< the last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>.
< The <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_node" title="psyneulink.core.compositions.composition.Composition.get_results_by_node"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_node</span></code></a> method.</p>
---
> <code class="xref any docutils literal notranslate"><span class="pre">TRIAL</span></code> (a list of the <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> for all of its <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> <a class="reference internal" href="#composition-nodes"><span class="std std-ref">Nodes</span></a>) are added to
> the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.results" title="psyneulink.core.compositions.composition.Composition.results"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">results</span></code></a> attribute, and the <code class="xref any docutils literal notranslate"><span class="pre">output_values</span></code> for the
> last <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> executed is returned by the <a class="reference internal" href="#composition-execution-methods"><span class="std std-ref">execution method</span></a>. The
> <a class="reference internal" href="Mechanism.html#psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.output_values"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">output_values</span></code></a> of the last <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> for each <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>
> can be seen using the Composition’s <a class="reference internal" href="#psyneulink.core.compositions.composition.Composition.get_results_by_nodes" title="psyneulink.core.compositions.composition.Composition.get_results_by_nodes"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">get_results_by_nodes</span></code></a> method.</p>
4547c4547
< <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
---
> <span class="sig-name descname"><span class="pre">get_input_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_trials</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_nested_input_nodes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_input_format" title="Permalink to this definition">¶</a></dt>
4565,4584c4565,4566
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_output_format">
< <span class="sig-name descname"><span class="pre">get_output_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_output_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easily confused!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_result_format">
< <span class="sig-name descname"><span class="pre">get_result_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#psyneulink.core.compositions.composition.Composition.get_result_format" title="Permalink to this definition">¶</a></dt>
< <dd><p>Alias for get_results_format (easy mistake to make!)</p>
< </dd></dl>
< 
< <dl class="py method">
< <dt class="sig sig-object py" id="psyneulink.core.compositions.composition.Composition.get_results_format">
< <span class="sig-name descname"><span class="pre">get_results_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span c
...

See CI logs for the full diff.

@jdcpni jdcpni merged commit 9979c07 into devel Dec 23, 2021
@jdcpni jdcpni deleted the feat/comp/inputs branch December 23, 2021 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants