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

showgraph, docs: give more information on system graphviz #3159

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

kmantel
Copy link
Collaborator

@kmantel kmantel commented Jan 10, 2025

No description provided.

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/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/Mechanism.html docs-head/Mechanism.html
1887,1888c1887,1891
< <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>, which must be installed and imported
< (standard with PsyNeuLink pip install)</p>
---
> <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>
> python and system packages, which must be installed. The
> python package comes standard with PsyNeuLink pip install,
> but the system package must be installed separately. It can
> be downloaded at <a class="reference external" href="https://www.graphviz.org/download/">https://www.graphviz.org/download/</a>.</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.emcompo
...

See CI logs for the full diff.

catch graphviz ExecutableNotFound error and re-raise to explain the
source of the problem and where to download system graphviz
Copy link

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

diff -r docs-base/Mechanism.html docs-head/Mechanism.html
1887,1888c1887,1891
< <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>, which must be installed and imported
< (standard with PsyNeuLink pip install)</p>
---
> <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>
> python and system packages, which must be installed. The
> python package comes standard with PsyNeuLink pip install,
> but the system package must be installed separately. It can
> be downloaded at <a class="reference external" href="https://www.graphviz.org/download/">https://www.graphviz.org/download/</a>.</p>
diff -r docs-base/Visualization.html docs-head/Visualization.html
424,425c424,428
< <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>, which must be installed and imported
< (standard with PsyNeuLink pip install)</p>
---
> <p>This method relies on <a class="reference external" href="http://www.graphviz.org">graphviz</a>
> python and system packages, which must be installed. The
> python package comes standard with PsyNeuLink pip install,
> but the system package must be installed separately. It can
> be downloaded at <a class="reference external" href="https://www.graphviz.org/download/">https://www.graphviz.org/download/</a>.</p>
diff -r docs-base/searchindex.js docs-head/searchindex.js
1c1
< Search.setIndex({docnames:["AGT","AGTControlMechanism","AutoAssociativeLearningMechanism","AutoAssociativeProjection","AutodiffComposition","BasicsAndPrimer","BeukersNBackModel","BeukersNBackModel_NB","BotvinickConflictMonitoringModel","BustamanteStroopXORLVOCModel","Cohen_HustonModel","ComparatorMechanism","Compilation","Component","Components","Composition","CompositionFunctionApproximator","CompositionInterfaceMechanism","Compositions","Condition","Context","ContrastiveHebbianMechanism","ContributorsGuide","ControlMechanism","ControlMechanisms","ControlProjection","ControlProjections","ControlSignal","ConventionsAndDefinitions","Core","DDM","DefaultControlMechanism","Defaults","DistributionFunctions","EMComposition","EVC","EVCAuxiliary","EVCControlMechanism","EpisodicMemoryMechanism","Function","Functions","GatingMechanism","GatingMechanisms","GatingProjection","GatingProjections","GatingSignal","GilzenratModel","InputPort","IntegratorFunctions","IntegratorMechanism","IntegratorMechanisms","KWTAMechanism","Keywords","KohonenMechanism","LCAMechanism","LCControlMechanism","LCMechanism","LLVM","LeabraMechanism","LearningFunctions","LearningMechanism","LearningMechanisms","LearningProjection","LearningProjections","LearningSignal","Library","Log","MappingProjection","MaskedMappingProjection","Mechanism","Mechanisms","MemoryFunctions","Models","ModulatoryMechanism","ModulatoryMechanisms","ModulatoryProjection","ModulatoryProjections","ModulatorySignal","MontagueModel","NieuwenhuisModel","NonStatefulFunctions","ObjectiveFunctions","ObjectiveMechanism","ObjectiveMechanisms","OptimizationControlMechanism","OptimizationFunctions","OutputPort","PCTC_model","ParameterEstimationComposition","ParameterPort","Parameters","Pathway","PathwayProjection","PathwayProjections","Port","PredictionErrorMechanism","Preferences","ProcessingMechanism","ProcessingMechanisms","Projection","Projections","QuickReference","RecurrentTransferMechanism","RefactoredLearningGuide","Registry","RegressionCFA","Report","Scheduler","Scheduling","SelectionFunctions","Services","StatefulFunction","StatefulFunctions","Subystems","Time","TimerFunctions","TimerMechanism","TransferFunctions","TransferMechanism","TransferMechanisms","TransformFunctions","UserDefinedFunction","UserGuide","UserGuide_TBD","Visualization","globals","index","index_logo_with_text","mdf","nback_nb"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["AGT.rst","AGTControlMechanism.rst","AutoAssociativeLearningMechanism.rst","AutoAssociativeProjection.rst","AutodiffComposition.rst","BasicsAndPrimer.rst","BeukersNBackModel.rst","BeukersNBackModel_NB.rst","BotvinickConflictMonitoringModel.rst","BustamanteStroopXORLVOCModel.rst","Cohen_HustonModel.rst","ComparatorMechanism.rst","Compilation.rst","Component.rst","Components.rst","Composition.rst","CompositionFunctionApproximator.rst","CompositionInterfaceMechanism.rst","Compositions.rst","Condition.rst","Context.rst","ContrastiveHebbianMechanism.rst","ContributorsGuide.rst","ControlMechanism.rst","ControlMechanisms.rst","ControlProjection.rst","ControlProjections.rst","ControlSignal.rst","ConventionsAndDefinitions.rst","Core.rst","DDM.rst","DefaultControlMechanism.rst","Defaults.rst","DistributionFunctions.rst","EMComposition.rst","EVC.rst","EVCAuxiliary.rst","EVCControlMechanism.rst","EpisodicMemoryMechanism.rst","Function.rst","Functions.rst","GatingMechanism.rst","GatingMechanisms.rst","GatingProjection.rst","GatingProjections.rst","GatingSignal.rst","GilzenratModel.rst","InputPort.rst","IntegratorFunctions.rst","IntegratorMechanism.rst","IntegratorMechanisms.rst","KWTAMechanism.rst","Keywords.rst","KohonenMechanism.rst","LCAMechanism.rst","LCControlMechanism.rst","LCMechanism.rst","LLVM.rst","LeabraMechanism.rst","LearningFunctions.rst","LearningMechanism.rst","LearningMechanisms.rst","LearningProjection.rst","LearningProjections.rst","LearningSignal.rst","Library.rst","Log.rst","MappingProjection.rst","MaskedMappingProjection.rst","Mechanism.rst","Mechanisms.rst","MemoryFunctions.rst","Models.rst","ModulatoryMechanism.rst","ModulatoryMechanisms.rst","ModulatoryProjection.rst","ModulatoryProjections.rst","ModulatorySignal.rst","MontagueModel.rst","NieuwenhuisModel.rst","NonStatefulFunctions.rst","ObjectiveFunctions.rst","ObjectiveMechanism.rst","ObjectiveMechanisms.rst","OptimizationControlMechanism.rst","OptimizationFunctions.rst","OutputPort.rst","PCTC_model.rst","ParameterEstimationComposition.rst","ParameterPort.rst","Parameters.rst","Pathway.rst","PathwayProjection.rst","PathwayProjections.rst","Port.rst","PredictionErrorMechanism.rst","Preferences.rst","ProcessingMechanism.rst","ProcessingMechanisms.rst","Projection.rst","Projections.rst","QuickReference.rst","RecurrentTransferMechanism.rst","RefactoredLearningGuide.rst","Registry.rst","RegressionCFA.rst","Report.rst","Scheduler.rst","Scheduling.rst","SelectionFunctions.rst","Services.rst","StatefulFunction.rst","StatefulFunctions.rst","Subystems.rst","Time.rst","TimerFunctions.rst","TimerMechanism.rst","TransferFunctions.rst","TransferMechanism.rst","TransferMechanisms.rst","TransformFunctions.rst","UserDefinedFunction.rst","UserGuide.rst","UserGuide_TBD.rst","Visualization.rst","globals.rst","index.rst","index_logo_with_text.rst","mdf.rst","nback_nb.ipynb"],objects:{"psyneulink.core.components":{component:[13,0,0,"-"]},"psyneulink.core.components.component":{Component:[13,1,1,""]},"psyneulink.core.components.component.Component":{"function":[13,4,1,""],_check_args:[13,2,1,""],_check_for_composition:[13,2,1,""],_deferred_init:[13,2,1,""],_dependent_components:[13,3,1,""],_get_allowed_arguments:[13,2,1,""],_get_param_value_from_tuple:[13,2,1,""],_handle_default_variable:[13,2,1,""],_handle_input_shapes:[13,2,1,""],_initialize_parameters:[13,2,1,""],_instantiate_defaults:[13,2,1,""],_instantiate_function:[13,2,1,""],_instantiate_parameter_classes:[13,2,1,""],_model_spec_class_name_is_generic:[13,4,1,""],_model_spec_generic_type_name:[13,4,1,""],_model_spec_parameter_blacklist:[13,3,1,""],_parameter_components:[13,3,1,""],_parse_arg_generic:[13,2,1,""],_parse_arg_variable:[13,2,1,""],_parse_function_variable:[13,2,1,""],_parse_input_shapes:[13,2,1,""],_receiver_ports:[13,3,1,""],_sender_ports:[13,3,1,""],_set_multiple_parameter_values:[13,2,1,""],_specified_variable_shape_flexibility:[13,4,1,""],_validate:[13,2,1,""],_validate_and_assign_runtime_params:[13,2,1,""],_validate_arguments:[13,2,1,""],_validate_function:[13,2,1,""],_validate_params:[13,2,1,""],_validate_variable:[13,2,1,""],all_dependent_parameters:[13,2,1,""],current_execution_time:[13,4,1,""],defaults:[13,4,1,""],execute:[13,2,1,""],execute_until_finished:[13,4,1,""],execution_count:[13,4,1,""],function_parameters:[13,3,1,""],get_afferents:[13,2,1,""],get_efferents:[13,2,1,""],initialization_status:[13,4,1,""],input_shapes:[13,4,1,""],is_finished:[13,2,1,""],log:[13,4,1,""],log_values:[13,2,1,""],loggable_items:[13,3,1,""],logged_items:[13,3,1,""],max_executions_before_finished:[13,4,1,""],most_recent_context:[13,3,1,""],name:[13,4,1,""],num_executions:[13,4,1,""],num_executions_before_finished:[13,4,1,""],parameters:[13,4,1,""],prefs:[13,4,1,""],reset:[13,2,1,""],reset_params:[13,2,1,""],reset_stateful_function_when:[13,4,1,""],set_delivery_conditions:[13,2,1,""],set_log_conditions:[13,2,1,""],stateful_parameters:[13,3,1,"id0"],value:[13,4,1,""],variable:[13,4,1,""]},"psyneulink.core.components.functions":{"function":[40,0,0,"-"],distributionfunctions:[33,0,0,"-"],learningfunctions:[59,0,0,"-"],objectivefunctions:[81,0,0,"-"],optimizationfunctions:[85,0,0,"-"],selectionfunctions:[109,0,0,"-"],transformfunctions:[120,0,0,"-"],userdefinedfunction:[121,0,0,"-"]},"psyneulink.core.components.functions.distributionfunctions":{DistributionFunction:[33,1,1,""],DriftDiffusionAnalytical:[33,1,1,""],ExponentialDist:[33,1,1,""],GammaDist:[33,1,1,""],NormalDist:[33,1,1,""],UniformDist:[33,1,1,""],UniformToNormalDist:[33,1,1,""],WaldDist:[33,1,1,""]},"psyneulink.core.components.functions.distributionfunctions.DriftDiffusionAnalytical":{_compute_conditional_rt_moments:[33,2,1,""],_function:[33,2,1,""],bias:[33,4,1,""],derivative:[33,2,1,""],drift_rate:[33,4,1,""],name:[33,4,1,""],noise:[33,4,1,""],non_decision_time:[33,4,1,""],owner:[33,4,1,""],prefs:[33,4,1,""],shenhav_et_al_compat_mode:[33,3,1,""],starting_value:[33,4,1,""],threshold:[33,4,1,""],variable:[33,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.ExponentialDist":{beta:[33,4,1,""],name:[33,4,1,""],owner:[33,4,1,""],params:[33,4,1,""],prefs:[33,4,1,""],random_state:[33,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.GammaDist":{dist_shape:[33,4,1,""],name:[33,4,1,""],owner:[33,4,1,""],params:[33,4,1,""],prefs:[33,4,1,""],random_state:[33,4,1,""],scale:[33,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.NormalDist":{_validate_params:[33,2,1,""],mean:[33,4,1,""],name:[33,4,1,""],owner:[33,4,1,""],params:[33,4,1,""],prefs:[33,4,1,""],random_state:[33,4,1,""],standard_deviation:[33,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.UniformDist":{high:[33,4,1,""],low:[33,4,1,""],name:[33,4,1,""],owner:[33,4,1,""],params:[33,4,1,""],prefs:[33,4,1,""],random_state:[33,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.UniformToNormalDist":{mean:[33,4,1,""],name:[33,4,1,""],owner:[33,4,1,""],params:[33,4,1,""],prefs:[33,4,1,""],random_state:[33,4,1,""],standard_deviation:[33,4,1,""]},"psyneulink.core.components.functions.function":{ArgumentTherapy:[40,1,1,""],Function_Base:[40,1,1,""],RandomMatrix:[40,1,1,""]},"psyneulink.core.components.functions.function.ArgumentTherapy":{Manner:[40,1,1,""],_function:[40,2,1,""],_validate_params:[40,2,1,""],_validate_variable:[40,2,1,""],name:[40,4,1,""],owner:[40,4,1,""],pertinacity:[40,4,1,""],prefs:[40,4,1,""],propensity:[40,4,1,""],variable:[40,4,1,""]},"psyneulink.core.components.functions.function.Function_Base":{"function":[40,4,1,""],_assign_to_mdf_model:[40,2,1,""],_get_pytorch_fct_param_value:[40,2,1,""],_model_spec_parameter_blacklist:[40,3,1,""],_parse_arg_generic:[40,2,1,""],_validate_parameter_spec:[40,2,1,""],name:[40,4,1,""],owner:[40,4,1,""],prefs:[40,4,1,""],value:[40,4,1,""],variable:[40,4,1,""]},"psyneulink.core.components.functions.function.RandomMatrix":{center:[40,4,1,""],range:[40,4,1,""]},"psyneulink.core.components.functions.learningfunctions":{BackPropagation:[59,1,1,""],BayesGLM:[59,1,1,""],ContrastiveHebbian:[59,1,1,""],Hebbian:[59,1,1,""],Kohonen:[59,1,1,""],LearningFunction:[59,1,1,""],Reinforcement:[59,1,1,""],TDLearning:[59,1,1,""]},"psyneulink.core.components.functions.learningfunctions.BackPropagation":{_function:[59,2,1,""],_validate_params:[59,2,1,""],_validate_variable:[59,2,1,""],activation_derivative_fct:[59,4,1,""],activation_input:[59,4,1,""],activation_output:[59,4,1,""],covariates:[59,4,1,""],error_matrix:[59,4,1,""],error_signal:[59,4,1,""],learning_rate:[59,4,1,""],loss_spec:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.BayesGLM":{Lambda_n:[59,4,1,""],Lambda_prior:[59,4,1,""],_function:[59,2,1,""],_handle_default_variable:[59,2,1,""],gamma_shape_0:[59,4,1,""],gamma_shape_n:[59,4,1,""],gamma_shape_prior:[59,4,1,""],gamma_size_0:[59,4,1,""],gamma_size_n:[59,4,1,""],gamma_size_prior:[59,4,1,""],initialize_priors:[59,2,1,""],mu_0:[59,4,1,""],mu_n:[59,4,1,""],mu_prior:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],random_state:[59,4,1,""],reset:[59,2,1,""],sample_weights:[59,2,1,""],sigma_0:[59,4,1,""],variable:[59,4,1,""],weights_sample:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.ContrastiveHebbian":{"function":[59,4,1,""],_function:[59,2,1,""],_validate_params:[59,2,1,""],_validate_variable:[59,2,1,""],learning_rate:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.Hebbian":{"function":[59,4,1,""],_function:[59,2,1,""],_validate_params:[59,2,1,""],_validate_variable:[59,2,1,""],learning_rate:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.Kohonen":{"function":[59,4,1,""],_function:[59,2,1,""],_validate_params:[59,2,1,""],_validate_variable:[59,2,1,""],learning_rate:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.LearningFunction":{learning_rate:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.Reinforcement":{"function":[59,4,1,""],_function:[59,2,1,""],_validate_params:[59,2,1,""],_validate_variable:[59,2,1,""],activation_input:[59,4,1,""],activation_output:[59,4,1,""],error_signal:[59,4,1,""],learning_rate:[59,4,1,""],owner:[59,4,1,""],prefs:[59,4,1,""],variable:[59,4,1,""]},"psyneulink.core.components.functions.learningfunctions.TDLearning":{_validate_variable:[59,2,1,""]},"psyneulink.core.components.functions.nonstateful":{timerfunctions:[115,0,0,"-"],transferfunctions:[117,0,0,"-"]},"psyneulink.core.components.functions.nonstateful.timerfunctions":{AcceleratingTimer:[115,1,1,""],AsymptoticTimer:[115,1,1,""],DeceleratingTimer:[115,1,1,""],LinearTimer:[115,1,1,""],TimerFunction:[115,1,1,""]},"psyneulink.core.components.functions.nonstateful.timerfunctions.AcceleratingTimer":{"final":[115,4,1,""],_function:[115,2,1,""],derivative:[115,2,1,""],duration:[115,4,1,""],initial:[115,4,1,""],name:[115,4,1,""],owner:[115,4,1,""],prefs:[115,4,1,""],rate:[115,4,1,""],variable:[115,4,1,""]},"psyneulink.core.components.functions.nonstateful.timerfunctions.AsymptoticTimer":{"final":[115,4,1,""],_function:[115,2,1,""],bounds:[115,4,1,""],derivative:[115,2,1,""],duration:[115,4,1,""],initial:[115,4,1,""],name:[115,4,1,""],owner:[115,4,1,""],prefs:[115,4,1,""],tolerance:[115,4,1,""],variable:[115,4,1,""]},"psyneulink.core.components.functions.nonstateful.timerfunctions.DeceleratingTimer":{"final":[115,4,1,""],_function:[115,2,1,""],derivative:[115,2,1,""],duration:[115,4,1,""],initial:[115,4,1,""],name:[115,4,1,""],owner:[115,4,1,""],prefs:[115,4,1,""],rate:[115,4,1,""],variable:[115,4,1,""]},"psyneulink.core.components.functions.nonstateful.timerfunctions.LinearTimer":{"final":[115,4,1,""],_function:[115,2,1,""],derivative:[115,2,1,""],duration:[115,4,1,""],initial:[115,4,1,""],name:[115,4,1,""],owner:[115,4,1,""],prefs:[115,4,1,""],variable:[115,4,1,""]},"psyneulink.core.components.functions.nonstateful.timerfunctions.TimerFunction":{"final":[115,4,1,""],duration:[115,4,1,""],initial:[115,4,1,""],rate:[115,4,1,""],variable:[115,4,1,""]},"psyneulink.core.compon
...

See CI logs for the full diff.

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