docs: add markdown documentation#13
Conversation
arjunsridhar12345
requested review from
arielleleon,
dougollerenshaw and
micahwoodard
| | Trials column | Mapping | | ||
| | --- | --- | | ||
| | `auto_waterL` / `auto_waterR` | From `is_auto_response_right`. `NULL` for None, `true` for right, `false` for left. Encoded `0`/`1`. | | ||
| | `bait_left` / `bait_right` | Boolean. `bait_right` is `True` if `p_reward_right == 1` and `auto_response_right` is `None` or `False`. `bait_left` is `True` if `p_reward_left == 1` and `auto_response_right` is `None` or `True`. | |
There was a problem hiding this comment.
bait_left/bait_right both depend on auto_response_right. Is that the intended behavior or a typo?
There was a problem hiding this comment.
should be the intended behavior. there is a typo in the column name as called out in the next comment. I tried to add some information here, saying that the value it takes on determines left or right: d645c2e
|
|
||
| | Trials column | Mapping | | ||
| | --- | --- | | ||
| | `auto_waterL` / `auto_waterR` | From `is_auto_response_right`. `NULL` for None, `true` for right, `false` for left. Encoded `0`/`1`. | |
There was a problem hiding this comment.
In the next line, you refer to a variable called auto_response_right. here you refer to is_auto_response_right. Are these two different variables or is one of the names incorrect?
There was a problem hiding this comment.
great catch! is_auto_response_right is the correct one. These are the same, it's a typo. Tried to address here: d645c2e
| | `bait_left` / `bait_right` | Boolean. `bait_right` is `True` if `p_reward_right == 1` and `auto_response_right` is `None` or `False`. `bait_left` is `True` if `p_reward_left == 1` and `auto_response_right` is `None` or `True`. | | ||
| | `response_duration` | `response_deadline_duration`. | | ||
| | `reward_consumption_duration` | `Trial -> reward_consumption_duration`. | | ||
| | `reward_probabilityL` / `reward_probabilityR` | Most likely the block probability: `Trial -> Metadata -> p_reward_left` / `p_reward_right`. Confirm with Alex whether the actual lickspout probability is intended. | |
There was a problem hiding this comment.
Can you clean up the "Confirm with Alex whether the actual lickspout probability is intended." by getting that info from @alexpiet prior to merging this PR?
There was a problem hiding this comment.
I added Alex as a reviewer. I think we may have talked about this already and I forgot to write it down. But from discussing with Micah, I think she said it is the probability within the block if I am understanding and remembering right
| | `right_valve_open_time` | `SupplyPort1`. | | ||
|
|
||
| Cross-correlate with software-event manual-reward times from the UI against | ||
| trial `start_time`/`stop_time` to disambiguate manual valve opens. Double-check |
There was a problem hiding this comment.
What does your "Double-check this" note here mean? Can you confirm before commiting this file?
There was a problem hiding this comment.
Added Alex as reviewer for this. I think from meeting with Micah, this is asking if manual valve openings need to be kept track of as well
| `default_grouping`: | ||
|
|
||
| ```python | ||
| default_grouping = ["test_suite", [<every suite name seen in the metrics>]] |
There was a problem hiding this comment.
Could you be a bit clearer about what this "default_grouping" is for and what it accomplishes? How does it interact with what you say below on lines 191-192 about 'behavior' sitting in its own top level group?
There was a problem hiding this comment.
Tried to address here: b581220.
It's for mainly organizing the visualization of the metrics and trying to group them into a tree like hierarchy in the portal
dougollerenshaw
left a comment
dougollerenshaw
left a comment
There was a problem hiding this comment.
Approved, but please address inline comments first.
|
merging this to dev, will check with Micah when she's back next week and will open any issues then as they arise |
3 participants
This PR attempts to add initial markdown files from documentation in the issues below. Currently is in the docs top level folder. Any updates can then be version controlled with these files:
UPDATE: I also decided to lump in a qc markdown as well: #14