From a3230a2604be37ae248395e3e612893bfae8c930 Mon Sep 17 00:00:00 2001
From: Asaf Zorea <zoreasaf@gmail.com>
Date: Mon, 15 Jul 2024 19:09:01 +0300
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 670eaeb..8fc8526 100644
--- a/README.md
+++ b/README.md
@@ -73,14 +73,13 @@ The model outputs spikes based on the excitatory inputs, except when inhibited b
 specified time window from the inhibitory inputs.
 
 - **Parameters:**
-    - `excitatory_input (np.ndarray)`: 1D array of spike times or binary spikes from the excitatory neuron.
-    - `inhibitory_inputs (np.ndarray)`: 1D or 2D array of spike times or binary spikes from one or more inhibitory
-      neurons.
+    - `excitatory_input (np.ndarray)`: 1D or 2D array of instantaneous rates of one or more excitatory neuron.
+    - `inhibitory_inputs (np.ndarray)`: 1D or 2D array of instantaneous rate of one or more inhibitory neurons.
     - `delta_s (float)`: Coincidence integration duration in seconds, defining the time window for inhibition.
     - `fs (float)`: Sampling frequency in Hz.
 
 - **Returns:**
-    - `np.ndarray`: Output spike times or binary spike array after applying the excitatory-inhibitory interaction.
+    - `np.ndarray`: Output instantaneous rates array after applying the excitatory-inhibitory interaction.
 
 #### `simple_ee(inputs, delta_s, fs)`
 
@@ -88,12 +87,12 @@ Simplifies the model of excitatory-excitatory (EE) interaction where an output s
 spike within a specified time interval.
 
 - **Parameters:**
-    - `inputs (np.ndarray)`: 2D array of excitatory input spikes.
+    - `inputs (np.ndarray)`: 2D array of excitatory input instantaneous rates.
     - `delta_s (float)`: Coincidence integration duration in seconds.
     - `fs (float)`: Sampling frequency in Hz.
 
 - **Returns:**
-    - `np.ndarray`: Output spike times or binary spike array after applying the EE interaction.
+    - `np.ndarray`: Output instantaneous rates array after applying the EE interaction.
 
 #### `ee(inputs, n_spikes, delta_s, fs)`
 
@@ -101,13 +100,13 @@ A general excitatory-excitatory (EE) cell model that generates a spike whenever
 spike simultaneously within a specific time interval.
 
 - **Parameters:**
-    - `inputs (np.ndarray)`: 2D array of excitatory input spikes.
+    - `inputs (np.ndarray)`: 2D array of excitatory input instantaneous rates.
     - `n_spikes (int)`: Minimum number of inputs that must spike simultaneously.
     - `delta_s (float)`: Coincidence integration duration in seconds.
     - `fs (float)`: Sampling frequency in Hz.
 
 - **Returns:**
-    - `np.ndarray`: Output spike times or binary spike array based on the input conditions.
+    - `np.ndarray`: Output instantaneous rates array based on the input conditions.
 
 #### `cd(excitatory_inputs, inhibitory_inputs, n_spikes, delta_s, fs)`
 
@@ -115,14 +114,14 @@ Models the output of a coincidence detector (CD) cell which generates spikes bas
 excitatory and inhibitory inputs within a defined interval.
 
 - **Parameters:**
-    - `excitatory_inputs (np.ndarray)`: 2D array of excitatory input spikes.
-    - `inhibitory_inputs (np.ndarray)`: 2D array of inhibitory input spikes.
+    - `excitatory_inputs (np.ndarray)`: 2D array of excitatory input instantaneous rates.
+    - `inhibitory_inputs (np.ndarray)`: 2D array of inhibitory input instantaneous rates.
     - `n_spikes (int)`: Minimum excess of excitatory spikes over inhibitory spikes required to generate an output spike.
     - `delta_s (float)`: Interval length in seconds.
     - `fs (float)`: Sampling frequency in Hz.
 
 - **Returns:**
-    - `np.ndarray`: Output spike array after applying the CD interaction based on the relative timing and number of
+    - `np.ndarray`: Output instantaneous rates after applying the CD interaction based on the relative timing and number of
       inputs.
 
 ## Installation
@@ -152,4 +151,4 @@ pre-commit run --all-files
 ## Reference
 
 Krips R, Furst M. Stochastic properties of auditory brainstem coincidence detectors in binaural perception.
-J Acoust Soc Am. 2009 Mar;125(3):1567-83. doi: 10.1121/1.3068446. PMID: 19275315.
\ No newline at end of file
+J Acoust Soc Am. 2009 Mar;125(3):1567-83. doi: 10.1121/1.3068446. PMID: 19275315.