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

Patch/transferfunctions/logistic offset #3169

Closed
wants to merge 33 commits into from

Conversation

jdcpni
Copy link
Collaborator

@jdcpni jdcpni commented Jan 26, 2025

No description provided.

jdcpni and others added 30 commits October 31, 2024 08:38
• transferfunctions.py:
  Logistic(): modify offset to be vertical vs. horizontal
• transferfunctions.py:
  Logistic(): modify offset to be vertical vs. horizontal
• transferfunctions.py
  Logistic:  add _validate_bounds() to be compatible with any assignments to scale and/or offset
• transferfunctions.py
  TransferFunction:  add _set_bounds() to be compatible with any assignments to scale and/or offset
• transferfunctions.py
  TransferFunction:  add _set_bounds() to be compatible with any assignments to scale and/or offset
• transfermechanism.py
  _validate_params: add warning for ineffective values of clip
PASSES ALL TESTS
PASSES ALL TESTS
• transferfunctions.py, transfermechanism.py:  mods to docstrings.
• test_transfer_mechanism.py
  add test_clip_with_respect_to_fct_bounds()
Copy link

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

diff -r docs-base/KohonenMechanism.html docs-head/KohonenMechanism.html
405c405
< <dd><p>Determine numberr of items expected by termination_measure</p>
---
> <dd><p>Determine number of items expected by termination_measure and check clip if specified</p>
diff -r docs-base/TimerFunctions.html docs-head/TimerFunctions.html
991c991
< <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">psyneulink.core.components.functions.nonstateful.timerfunctions.</span></span><span class="sig-name descname"><span class="pre">TimerFunction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default_variable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner</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">name</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">prefs</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">context</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="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.components.functions.nonstateful.timerfunctions.TimerFunction" title="Permalink to this definition">¶</a></dt>
---
> <em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">psyneulink.core.components.functions.nonstateful.timerfunctions.</span></span><span class="sig-name descname"><span class="pre">TimerFunction</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.components.functions.nonstateful.timerfunctions.TimerFunction" title="Permalink to this definition">¶</a></dt>
diff -r docs-base/TransferFunctions.html docs-head/TransferFunctions.html
233,239c233,236
< <p>All TransferFunctions have the following attributes:</p>
< <ul class="simple">
< <li><p><strong>bounds</strong>:  specifies the lower and upper limits of the result;  if there are none, the attribute is set to
< <code class="xref any docutils literal notranslate"><span class="pre">None</span></code>;  if it has at least one bound, the attribute is set to a tuple specifying the lower and upper bounds,
< respectively, with <code class="xref any docutils literal notranslate"><span class="pre">None</span></code> as the entry for no bound.</p></li>
< </ul>
< <ul class="simple">
---
> <p>All TransferFunctions have the following attributes: <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.bounds" title="psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.bounds"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">bounds</span></code></a>,
> <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.scale" title="psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.scale"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">scale</span></code></a>, and <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.offset" title="psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.offset"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">offset</span></code></a>. In addition, they have a standardized pair of
> modulable parameters that are aliased to one of their primary parameters:</p>
> <ul class="simple" id="transferfunction-modulable-params">
241,243c238,240
< each of these is assigned the name of one of the function’s
< parameters and used by <a class="reference internal" href="ModulatoryProjection.html"><span class="doc">ModulatoryProjections</span></a> to modulate the output of the
< TransferFunction’s function (see <a class="reference internal" href="Functions.html#function-modulatory-params"><span class="std std-ref">Modulatory Parameters</span></a>).</p></li>
---
> each of these is assigned the name of one of the function’s parameters and used by <a class="reference internal" href="ModulatoryProjection.html"><span class="doc">ModulatoryProjections</span></a> to modulate the output of the TransferFunction’s function (see <a class="reference internal" href="Functions.html#function-modulatory-params"><span class="std std-ref">Modulatory Parameters</span></a>).
> By default, <strong>multiplicative_param</strong> is assigned to the function’s <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.scale" title="psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.scale"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">scale</span></code></a> Parameter
> and <strong>additive_param</strong> is assigned to the function’s <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.offset" title="psyneulink.core.components.functions.nonstateful.transferfunctions.TransferFunction.offset"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">offset</span></code></a> Parameter.</p></li>
1372,1374c1369
< <dd><p>determines the lower and upper limits of the result;  if at least one bound is specified, the attribute is
< a tuple specifying the lower and upper bounds, respectively, with <code class="xref any docutils literal notranslate"><span class="pre">None</span></code> as the entry for no bound.</p>
< <dl class="field-list simple">
---
> <dd><dl class="field-list simple">
1376c1371
< <dd class="field-odd"><p>Tuple or None</p>
---
> <dd class="field-odd"><p>(0,1)</p>
1474c1469
< \[scale * \frac{1}{1 + e^{ - gain ( variable + bias - x_{0} ) + offset}}\]</div>
---
> \[scale * \frac{1}{1 + e^{ - gain ( variable + bias - x_{0} )}}  + offset\]</div>
1479,1483c1474,1477
< accommodate the convention in the machine learning community; <strong>x_0</strong> is included to match the <a class="reference external" href="https://en.wikipedia.org/wiki/Logistic_function">standard
< form of the Logistic Function</a> (in which <strong>gain</strong>
< corresponds to the <em>k</em> parameter and <strong>scale</strong> corresponds to the <em>L</em> parameter); <strong>offset</strong> implements a
< form of bias that is not modulated by gain (i.e., it produces an offset of the function along the horizontal
< axis).</p>
---
> accommodate the convention in the machine learning community; <strong>x_0</strong> is included to match the <a class="reference external" href="https://en.wikipedia.org/wiki/Logistic_function">standard form
> of the Logistic Function</a> (in which <strong>gain</strong> corresponds to
> the <em>k</em> parameter and <strong>scale</strong> corresponds to the <em>L</em> parameter); <strong>offset</strong> implements a translation of the
> function along the vertical axis that is not modulated by gain.</p>
1492,1494c1486,1488
< <li><p><strong>gain</strong> (<em>float : default 1.0</em>) – specifies value by which to multiply each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after it is adjusted by
< <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">bias</span></code></a> and/or <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">x_0</span></code></a>, but before adjustment by <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">offset</span></code></a> and
< logistic transformation (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
---
> <li><p><strong>gain</strong> (<em>float : default 1.0</em>) – specifies value by which to multiply each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after it is
> adjusted by <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">bias</span></code></a> and/or <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">x_0</span></code></a>, but before logistic transformation
> (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
1499,1502c1493,1496
< <li><p><strong>offset</strong> (<em>float : default 0.0</em>) – specifies value to add to each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after adjusting by <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">bias</span></code></a> and/or <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">x_0</span></code></a> and applying <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.gain" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.gain"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">gain</span></code></a>, but before logistic
< transformation (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
< <li><p><strong>scale</strong> (<em>float : default 0.0</em>) – specifies value by which to multiply each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after all other parameters
< and logistic transformation have been applied (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
---
> <li><p><strong>offset</strong> (<em>float : default 0.0</em>) – specifies value to add to each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after logistic  transformation and
> <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.scale" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.scale"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">scale</span></code></a> have been applied (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
> <li><p><strong>scale</strong> (<em>float : default 0.0</em>) – specifies value value by which to multiply each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after logistic
> transformation but before <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">offset</span></code></a> has been applied (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above).</p></li>
1526,1527c1520,1522
< <dd><p>value by which to multiply each element of <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.variable"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">variable</span></code></a> after it is adjusted by <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.bias"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">bias</span></code></a> and/or <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.x_0"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">x_0</span></code></a>, but before adjustment by <a class="reference internal" href="#psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset" title="psyneulink.core.components.functions.nonstateful.transferfunctions.Logistic.offset"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">offset</span></code></a> and
< logistic transformation (see <a class="reference internal" href="#logistic-note"><span class="std std-ref">note</span></a> above
...

See CI logs for the full diff.

@jdcpni jdcpni closed this Jan 26, 2025
Copy link

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

diff -r docs-base/Component.html docs-head/Component.html
522c522
< <li><p><strong>execute_until_finished</strong> – determines whether the Component executes until its <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method returns True.
---
> <li><p><strong>execute_until_finished</strong> – determines whether the Component executes until its <a class="reference internal" href="#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method returns True.
524,525c524,525
< irrespective of its <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method;  if it is True then, depending on how its class implements and handles its
< <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method, the Component may execute more than once per call to its <a class="reference internal" href="#psyneulink.core.components.component.Component.execute" title="psyneulink.core.components.component.Component.execute"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">execute</span></code></a> method.</p></li>
---
> irrespective of its <a class="reference internal" href="#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method;  if it is True then, depending on how its class implements and handles its
> <a class="reference internal" href="#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method, the Component may execute more than once per call to its <a class="reference internal" href="#psyneulink.core.components.component.Component.execute" title="psyneulink.core.components.component.Component.execute"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">execute</span></code></a> method.</p></li>
530c530
< <a class="reference internal" href="#psyneulink.core.components.component.Component.execute" title="psyneulink.core.components.component.Component.execute"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">execute</span></code></a> method, or extend over several calls.  It is set to 0 each time <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> evaluates
---
> <a class="reference internal" href="#psyneulink.core.components.component.Component.execute" title="psyneulink.core.components.component.Component.execute"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">execute</span></code></a> method, or extend over several calls.  It is set to 0 each time <a class="reference internal" href="#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> evaluates
diff -r docs-base/Condition.html docs-head/Condition.html
463c463
< satisfied when the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of the specified node,       given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> satisfied when the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of the specified node,       given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
465c465
< satisfied when the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of any of the specified       nodes, given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> satisfied when the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of any of the specified       nodes, given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
467c467
< satisfied when the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of all of the specified       nodes, given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> satisfied when the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> method of all of the specified       nodes, given <a class="reference internal" href="Context.html#psyneulink.core.globals.context.Context.execution_id" title="psyneulink.core.globals.context.Context.execution_id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">execution_id</span></code></a> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
2154c2154
< <li><p>the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of the node specified in <strong>dependencies</strong> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> <li><p>the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of the node specified in <strong>dependencies</strong> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
2177c2177
< <li><p>the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of all nodes specified in <strong>dependencies</strong> return <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> <li><p>the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of all nodes specified in <strong>dependencies</strong> return <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
2203c2203
< <li><p>the <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of any nodes specified in <strong>dependencies</strong> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
---
> <li><p>the <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> methods of any nodes specified in <strong>dependencies</strong> returns <code class="xref any docutils literal notranslate"><span class="pre">True</span></code>.</p></li>
diff -r docs-base/KohonenMechanism.html docs-head/KohonenMechanism.html
405c405
< <dd><p>Determine numberr of items expected by termination_measure</p>
---
> <dd><p>Determine number of items expected by termination_measure and check clip if specified</p>
diff -r docs-base/LCAMechanism.html docs-head/LCAMechanism.html
345c345
< <li><p><strong>threshold</strong> (<em>float</em><em> or </em><em>None : default None</em>) – specifes the value at which the Mechanism’s <a class="reference internal" href="DDM.html#psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished" title="psyneulink.library.components.mechanisms.processing.integrator.ddm.DDM.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> attribute is set to True
---
> <li><p><strong>threshold</strong> (<em>float</em><em> or </em><em>None : default None</em>) – specifes the value at which the Mechanism’s <a class="reference internal" href="Component.html#psyneulink.core.components.component.Component.is_finished" title="psyneulink.core.components.component.Component.is_finished"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">is_finished</span></code></a> attribute is set to True
diff -r docs-base/LearningFunctions.html docs-head/LearningFunctions.html
1549c1549
< error_matrix passed in the <a class="reference internal" href="DistributionFunctions.html#psyneulink.core.components.functions.distributionfunctions.ExponentialDist.params" title="psyneulink.core.components.functions.distributionfunctions.ExponentialDist.params"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">params</span></code></a> argument.</p>
---
> error_matrix passed in the <a class="reference internal" href="AutodiffComposition.html#psyneulink.library.compositions.autodiffcomposition.AutodiffComposition.PytorchCompositionWrapper.params" title="psyneulink.library.compositions.autodiffcomposition.AutodiffComposition.PytorchCompositionWrapper.params"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">params</span></code></a> argument.</p>
diff -r docs-base/RefactoredLearningGuide.html docs-head/RefactoredLearningGuide.html
282c282
< <p>Notice that we no longer have to extract the target node from the <code class="xref any docutils literal notranslate"><span class="pre">add_backpropagation_learning_pathway</span> <span class="pre">method</span></code>, and can instead pass the targets as output nodes mapped to values, in a new parameter called <code class="xref any docutils literal notranslate"><span class="pre">targets</span></code> in the <a class="reference internal" href="EMComposition.html#psyneulink.library.compositions.emcomposition.EMComposition.learn" title="psyneulink.library.compositions.emcomposition.EMComposition.learn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">learn</span></code></a> method.</p>
---
> <p>Notice that we no longer have to extract the target node from the <code class="xref any docutils literal notranslate"><span class="pre">add_backpropagation_learning_pathway</span> <span class="pre">method</span></code>, and can instead pass the targets as output nodes mapped to values, in a new parameter called <code class="xref any docutils literal notranslate"><span class="pre">targets</span></code> in the <a class="reference internal" href="AutodiffComposition.html#psyneulink.library.compositions.autodiffcomposition.AutodiffComposition.learn" title="psyneulink.library.compositions.autodiffcomposition.AutodiffComposition.learn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">learn</span></code></a> method.</p>
287c287
< its constructor to be runtime parameters of its <a class="reference internal" href="EMComposition.html#psyneulink.library.compositions.emcomposition.EMComposition.learn" title="psyneulink.library.compositions.emcomposition.EMComposition.learn"><code class="xref any py py-meth docutils literal notranslate"><span class="pre">learn</span></code></a> method.</p>
---
> its constructor to be runtime parameters of its <a class="reference internal" href="AutodiffComposition.html#psyneulink.library.compositions.autodiffcomposition.AutodiffComposition.learn" title="psyneulin
...

See CI logs for the full diff.

@jdcpni jdcpni deleted the patch/transferfunctions/logistic_offset branch January 27, 2025 01:42
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.

1 participant