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

RecurrentTransferMechanism: make recurrent_projection a Parameter #2940

Merged

Conversation

kmantel
Copy link
Collaborator

@kmantel kmantel commented Apr 9, 2024

No description provided.

Copy link

github-actions bot commented Apr 9, 2024

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

diff -r docs-base/ModulatoryProjection.html docs-head/ModulatoryProjection.html
272c272
< <a class="reference internal" href="Port.html"><span class="doc">Port</span></a> are listed in the Port’s <a class="reference internal" href="ParameterPort.html#psyneulink.core.components.ports.parameterport.ParameterPort.mod_afferents" title="psyneulink.core.components.ports.parameterport.ParameterPort.mod_afferents"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">mod_afferents</span></code></a> attribute.</p>
---
> <a class="reference internal" href="Port.html"><span class="doc">Port</span></a> are listed in the Port’s <a class="reference internal" href="Mechanism.html#id15" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.mod_afferents"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">mod_afferents</span></code></a> attribute.</p>
diff -r docs-base/Port.html docs-head/Port.html
593c593
< <code class="xref any docutils literal notranslate"><span class="pre">PathWayProjections</span></code> (listed in its <a class="reference internal" href="#psyneulink.core.components.ports.port.Port_Base.path_afferents" title="psyneulink.core.components.ports.port.Port_Base.path_afferents"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">path_afferents</span></code></a> attribute) as the variable for its
---
> <code class="xref any docutils literal notranslate"><span class="pre">PathWayProjections</span></code> (listed in its <a class="reference internal" href="Mechanism.html#id14" title="psyneulink.core.components.mechanisms.mechanism.Mechanism_Base.path_afferents"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">path_afferents</span></code></a> attribute) as the variable for its
diff -r docs-base/RecurrentTransferMechanism.html docs-head/RecurrentTransferMechanism.html
680,685d679
< <dl class="py property">
< <dt class="sig sig-object py" id="psyneulink.library.components.mechanisms.processing.transfer.recurrenttransfermechanism.RecurrentTransferMechanism._dependent_components">
< <em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">_dependent_components</span></span><a class="headerlink" href="#psyneulink.library.components.mechanisms.processing.transfer.recurrenttransfermechanism.RecurrentTransferMechanism._dependent_components" title="Permalink to this definition">¶</a></dt>
< <dd><p>Returns a set of Components that will be executed if this Component is executed</p>
< </dd></dl>
< 
diff -r docs-base/genindex.html docs-head/genindex.html
363,364d362
<         <li><a href="RecurrentTransferMechanism.html#psyneulink.library.components.mechanisms.processing.transfer.recurrenttransfermechanism.RecurrentTransferMechanism._dependent_components">(psyneulink.library.components.mechanisms.processing.transfer.recurrenttransfermechanism.RecurrentTransferMechanism property)</a>
< </li>
Binary files docs-base/objects.inv and docs-head/objects.inv differ
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","CombinationFunctions","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","TransferFunctions","TransferMechanism","TransferMechanisms","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","CombinationFunctions.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","TransferFunctions.rst","TransferMechanism.rst","TransferMechanisms.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:[14,0,0,"-"]},"psyneulink.core.components.component":{Component:[14,1,1,""]},"psyneulink.core.components.component.Component":{"function":[14,4,1,""],_check_args:[14,2,1,""],_check_for_composition:[14,2,1,""],_deferred_init:[14,2,1,""],_dependent_components:[14,3,1,""],_get_allowed_arguments:[14,2,1,""],_get_param_value_from_tuple:[14,2,1,""],_handle_default_variable:[14,2,1,""],_handle_size:[14,2,1,""],_instantiate_defaults:[14,2,1,""],_instantiate_function:[14,2,1,""],_instantiate_parameter_classes:[14,2,1,""],_model_spec_class_name_is_generic:[14,4,1,""],_model_spec_generic_type_name:[14,4,1,""],_model_spec_parameter_blacklist:[14,3,1,""],_parameter_components:[14,3,1,""],_parse_arg_generic:[14,2,1,""],_parse_arg_variable:[14,2,1,""],_parse_function_variable:[14,2,1,""],_receiver_ports:[14,3,1,""],_sender_ports:[14,3,1,""],_set_multiple_parameter_values:[14,2,1,""],_specified_variable_shape_flexibility:[14,4,1,""],_validate:[14,2,1,""],_validate_and_assign_runtime_params:[14,2,1,""],_validate_arguments:[14,2,1,""],_validate_function:[14,2,1,""],_validate_params:[14,2,1,""],_validate_variable:[14,2,1,""],all_dependent_parameters:[14,2,1,""],current_execution_time:[14,4,1,""],defaults:[14,4,1,""],execute:[14,2,1,""],execute_until_finished:[14,4,1,""],execution_count:[14,4,1,""],function_parameters:[14,3,1,""],get_afferents:[14,2,1,""],get_efferents:[14,2,1,""],initialization_status:[14,4,1,""],is_finished:[14,2,1,""],log:[14,4,1,""],log_values:[14,2,1,""],loggable_items:[14,3,1,""],logged_items:[14,3,1,""],max_executions_before_finished:[14,4,1,""],most_recent_context:[14,3,1,""],name:[14,4,1,""],num_executions:[14,4,1,""],num_executions_before_finished:[14,4,1,""],parameters:[14,4,1,""],prefs:[14,4,1,""],reset:[14,2,1,""],reset_params:[14,2,1,""],reset_stateful_function_when:[14,4,1,""],set_delivery_conditions:[14,2,1,""],set_log_conditions:[14,2,1,""],size:[14,4,1,""],stateful_parameters:[14,3,1,"id0"],value:[14,4,1,""],variable:[14,4,1,""]},"psyneulink.core.components.functions":{"function":[41,0,0,"-"],combinationfunctions:[11,0,0,"-"],distributionfunctions:[34,0,0,"-"],learningfunctions:[60,0,0,"-"],objectivefunctions:[82,0,0,"-"],optimizationfunctions:[86,0,0,"-"],selectionfunctions:[110,0,0,"-"],transferfunctions:[116,0,0,"-"],userdefinedfunction:[119,0,0,"-"]},"psyneulink.core.components.functions.combinationfunctions":{CombineMeans:[11,1,1,""],Concatenate:[11,1,1,""],LinearCombination:[11,1,1,""],PredictionErrorDeltaFunction:[11,1,1,""],Rearrange:[11,1,1,""],Reduce:[11,1,1,""]},"psyneulink.core.components.functions.combinationfunctions.CombineMeans":{_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""],exponents:[11,4,1,""],name:[11,4,1,""],offset:[11,4,1,""],operation:[11,4,1,""],owner:[11,4,1,""],prefs:[11,4,1,""],scale:[11,4,1,""],variable:[11,4,1,""],weights:[11,4,1,""]},"psyneulink.core.components.functions.combinationfunctions.Concatenate":{_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""],default_variable:[11,4,1,""],derivative:[11,2,1,""],name:[11,4,1,""],offset:[11,4,1,""],owner:[11,4,1,""],prefs:[11,4,1,""],scale:[11,4,1,""]},"psyneulink.core.components.functions.combinationfunctions.LinearCombination":{_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""],derivative:[11,2,1,""],exponents:[11,4,1,""],name:[11,4,1,""],offset:[11,4,1,""],operation:[11,4,1,""],owner:[11,4,1,""],prefs:[11,4,1,""],scale:[11,4,1,""],variable:[11,4,1,""],weights:[11,4,1,""]},"psyneulink.core.components.functions.combinationfunctions.PredictionErrorDeltaFunction":{_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""]},"psyneulink.core.components.functions.combinationfunctions.Rearrange":{_function:[11,2,1,""],_instantiate_attributes_before_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""],arrangement:[11,4,1,""],default_variable:[11,4,1,""],name:[11,4,1,""],offset:[11,4,1,""],owner:[11,4,1,""],prefs:[11,4,1,""],scale:[11,4,1,""]},"psyneulink.core.components.functions.combinationfunctions.Reduce":{_function:[11,2,1,""],_validate_params:[11,2,1,""],_validate_variable:[11,2,1,""],default_variable:[11,4,1,""],name:[11,4,1,""],offset:[11,4,1,""],operation:[11,4,1,""],owner:[11,4,1,""],prefs:[11,4,1,""],scale:[11,4,1,""]},"psyneulink.core.components.functions.distributionfunctions":{DistributionFunction:[34,1,1,""],DriftDiffusionAnalytical:[34,1,1,""],ExponentialDist:[34,1,1,""],GammaDist:[34,1,1,""],NormalDist:[34,1,1,""],UniformDist:[34,1,1,""],UniformToNormalDist:[34,1,1,""],WaldDist:[34,1,1,""]},"psyneulink.core.components.functions.distributionfunctions.DriftDiffusionAnalytical":{_compute_conditional_rt_moments:[34,2,1,""],_function:[34,2,1,""],bias:[34,4,1,""],derivative:[34,2,1,""],drift_rate:[34,4,1,""],name:[34,4,1,""],noise:[34,4,1,""],non_decision_time:[34,4,1,""],owner:[34,4,1,""],prefs:[34,4,1,""],shenhav_et_al_compat_mode:[34,3,1,""],starting_value:[34,4,1,""],threshold:[34,4,1,""],variable:[34,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.ExponentialDist":{beta:[34,4,1,""],name:[34,4,1,""],owner:[34,4,1,""],params:[34,4,1,""],prefs:[34,4,1,""],random_state:[34,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.GammaDist":{dist_shape:[34,4,1,""],name:[34,4,1,""],owner:[34,4,1,""],params:[34,4,1,""],prefs:[34,4,1,""],random_state:[34,4,1,""],scale:[34,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.NormalDist":{_validate_params:[34,2,1,""],mean:[34,4,1,""],name:[34,4,1,""],owner:[34,4,1,""],params:[34,4,1,""],prefs:[34,4,1,""],random_state:[34,4,1,""],standard_deviation:[34,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.UniformDist":{high:[34,4,1,""],low:[34,4,1,""],name:[34,4,1,""],owner:[34,4,1,""],params:[34,4,1,""],prefs:[34,4,1,""],random_state:[34,4,1,""]},"psyneulink.core.components.functions.distributionfunctions.UniformToNormalDist":{mean:[34,4,1,""],name:[34,4,1,""],owner:[34,4,1,""],params:[34,4,1,""],prefs:[34,4,1,""],random_state:[34,4,1,""],standard_deviation:[34,4,1,""]},"psyneulink.core.components.functions.function":{ArgumentTherapy:[41,1,1,""],Function_Base:[41,1,1,""],RandomMatrix:[41,1,1,""]},"psyneulink.core.components.functions.function.ArgumentTherapy":{Manner:[41,1,1,""],_function:[41,2,1,""],_validate_params:[41,2,1,""],_validate_variable:[41,2,1,""],name:[41,4,1,""],owner:[41,4,1,""],pertinacity:[41,4,1,""],prefs:[41,4,1,""],propensity:[41,4,1,""],variable:[41,4,1,""]},"psyneulink.core.components.functions.function.Function_Base":{"function":[41,4,1,""],_assign_to_mdf_model:[41,2,1,""],_get_pytorch_fct_param_value:[41,2,1,""],_model_spec_parameter_blacklist:[41,3,1,""],_parse_arg_generic:[41,2,1,""],_validate_parameter_spec:[41,2,1,""],name:[41,4,1,""],owner:[41,4,1,""],prefs:[41,4,1,""],variable:[41,4,1,""]},"psyneulink.core.components.functions.function.RandomMatrix":{center:[41,4,1,""],range:[41,4,1,""]},"psyneulink.core.components.functions.learningfunctions":{BackPropagation:[60,1,1,""],BayesGLM:[60,1,1,""],ContrastiveHebbian:[60,1,1,""],Hebbian:[60,1,1,""],Kohonen:[60,1,1,""],LearningFunction:[60,1,1,""],Reinforcement:[60,1,1,""],TDLearning:[60,1,1,""]},"psyneulink.core.components.functions.learningfunctions.BackPropagation":{_function:[60,2,1,""],_validate_params:[60,2,1,""],_validate_variable:[60,2,1,""],activation_derivative_fct:[60,4,1,""],activation_input:[60,4,1,""],activation_output:[60,4,1,""],covariates:[60,4,1,""],error_matrix:[60,4,1,""],error_signal:[60,4,1,""],learning_rate:[60,4,1,""],loss_spec:[60,4,1,""],owner:[60,4,1,""],prefs:[60,4,1,""],variable:[60,4,1,""]},"psyneulink.core.components.functions.learning
...

See CI logs for the full diff.

@kmantel kmantel merged commit 267fb8a into PrincetonUniversity:devel Apr 9, 2024
32 checks passed
@kmantel kmantel deleted the recurrent_projection-param branch April 9, 2024 23:17
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