Add documentation to include workflows

bonsai-rx · Nov 20, 2024 · 1d07ed1 · 1d07ed1
1 parent 7d3d9bf
commit 1d07ed1
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 7 deletions.
diff --git a/src/Bonsai.ML.NeuralDecoder/ImportDecoderModule.bonsai b/src/Bonsai.ML.NeuralDecoder/ImportDecoderModule.bonsai
@@ -4,6 +4,7 @@
                  xmlns:py="clr-namespace:Bonsai.Scripting.Python;assembly=Bonsai.Scripting.Python"
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
                  xmlns="https://bonsai-rx.org/2018/workflow">
+  <Description>Import the Bayesian neural decoder module.</Description>
   <Workflow>
     <Nodes>
       <Expression xsi:type="WorkflowInput">

diff --git a/src/Bonsai.ML.NeuralDecoder/LoadClusterlessSpikeDecoder.bonsai b/src/Bonsai.ML.NeuralDecoder/LoadClusterlessSpikeDecoder.bonsai
@@ -7,10 +7,11 @@
                  xmlns:sys="clr-namespace:System;assembly=mscorlib"
                  xmlns:py="clr-namespace:Bonsai.Scripting.Python;assembly=Bonsai.Scripting.Python"
                  xmlns="https://bonsai-rx.org/2018/workflow">
+  <Description>Load a pickle object into an instance of the clusterless spike decoder class and set it to the referenced python variable.</Description>
   <Workflow>
     <Nodes>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="Name" />
+        <Property Name="Name" DisplayName="Name" Description="The name of the python variable referencing the model object."  Category="ModelReference" />
       </Expression>
       <Expression xsi:type="Combinator">
         <Combinator xsi:type="p1:CreateModelReference">
@@ -24,7 +25,7 @@
         <Selector>Name</Selector>
       </Expression>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="Value" DisplayName="DecoderPath" Description="Path to the decoder file" />
+        <Property Name="Value" DisplayName="DecoderPath" Description="Path to the decoder file." />
       </Expression>
       <Expression xsi:type="PropertySource" TypeArguments="io:CsvReader,sys:String">
         <MemberName>FileName</MemberName>

diff --git a/src/Bonsai.ML.NeuralDecoder/LoadDecodedResultsFromFile.bonsai b/src/Bonsai.ML.NeuralDecoder/LoadDecodedResultsFromFile.bonsai
@@ -7,6 +7,7 @@
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
                  xmlns:scr="clr-namespace:Bonsai.Scripting.Expressions;assembly=Bonsai.Scripting.Expressions"
                  xmlns="https://bonsai-rx.org/2018/workflow">
+  <Description>Loads the decoded results from a pickle file and emits the animals position, spikes, predictions, and position bins at a specified sampling frequency.</Description>
   <Workflow>
     <Nodes>
       <Expression xsi:type="ExternalizedMapping">
@@ -40,14 +41,14 @@
         <Combinator xsi:type="py:Exec" />
       </Expression>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="SamplingFrequency" />
+        <Property Name="SamplingFrequency" Description="The sampling frequency at which to emit the data." />
       </Expression>
       <Expression xsi:type="rx:SelectMany">
         <Name>Iterate</Name>
         <Workflow>
           <Nodes>
             <Expression xsi:type="ExternalizedMapping">
-              <Property Name="Period" DisplayName="SamplingFrequency" />
+              <Property Name="Period" DisplayName="SamplingFrequency" Description="The sampling frequency at which to emit the data." />
             </Expression>
             <Expression xsi:type="Combinator">
               <Combinator xsi:type="rx:Timer">

diff --git a/src/Bonsai.ML.NeuralDecoder/LoadSortedSpikeDecoder.bonsai b/src/Bonsai.ML.NeuralDecoder/LoadSortedSpikeDecoder.bonsai
@@ -7,10 +7,11 @@
                  xmlns:sys="clr-namespace:System;assembly=mscorlib"
                  xmlns:py="clr-namespace:Bonsai.Scripting.Python;assembly=Bonsai.Scripting.Python"
                  xmlns="https://bonsai-rx.org/2018/workflow">
+    <Description>Load a pickle object into an instance of the sorted spike decoder class and set it to the referenced python variable.</Description>
   <Workflow>
     <Nodes>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="Name" />
+        <Property Name="Name" DisplayName="Name" Description="The name of the python variable referencing the model object."  Category="ModelReference" />
       </Expression>
       <Expression xsi:type="Combinator">
         <Combinator xsi:type="p1:CreateModelReference">
@@ -24,7 +25,7 @@
         <Selector>Name</Selector>
       </Expression>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="Value" DisplayName="DecoderPath" Description="Path to the decoder file" />
+        <Property Name="Value" DisplayName="DecoderPath" Description="Path to the decoder file." />
       </Expression>
       <Expression xsi:type="PropertySource" TypeArguments="io:CsvReader,sys:String">
         <MemberName>FileName</MemberName>

diff --git a/...Bonsai.ML.NeuralDecoder/RunDecoder.bonsai → ....ML.NeuralDecoder/PerformInference.bonsai b/...Bonsai.ML.NeuralDecoder/RunDecoder.bonsai → ....ML.NeuralDecoder/PerformInference.bonsai
@@ -6,6 +6,7 @@
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
                  xmlns:p2="clr-namespace:Bonsai.ML.NeuralDecoder;assembly=Bonsai.ML.NeuralDecoder"
                  xmlns="https://bonsai-rx.org/2018/workflow">
+    <Description>Performs inference using the Bayesian neural decoder.</Description>
   <Workflow>
     <Nodes>
       <Expression xsi:type="WorkflowInput">
@@ -28,7 +29,7 @@
         </Combinator>
       </Expression>
       <Expression xsi:type="ExternalizedMapping">
-        <Property Name="Name" />
+        <Property Name="Name" DisplayName="Name" Description="The name of the python variable referencing the model object."  Category="ModelReference" />
       </Expression>
       <Expression xsi:type="SubscribeSubject" TypeArguments="p1:ModelReference">
         <Name>decoder</Name>