brainscore standardizes the interface between neuroscience metrics and the data they operate on. Brain recordings (termed "assemblies", e.g. neural or behavioral) are packaged in a standard format. This allows metrics (e.g. neural predictivity, RDMs) to operate on many assemblies without having to be re-written. Together with http://github.com/brain-score/candidate_models, brainscore allows scoring candidate models of the brain on a range of assemblies and metrics.

Recommended for most users. Use Brain-Score as a library. You will need Python >= 3.6 and pip >= 18.1.

pip install git+https://github.com/brain-score/brain-score

To contribute code to Brain-Score, see the Development Setup.

$ import brainscore
$ hvm = brainscore.get_assembly("dicarlo.Majaj2015")`
$ hvm
<xarray.NeuronRecordingAssembly 'dicarlo.Majaj2015' (neuroid: 296, presentation: 268800, time_bin: 1)>
array([[[ 0.060929],
        [-0.686162],
        ...,
Coordinates:
  * neuroid          (neuroid) MultiIndex
  - neuroid_id       (neuroid) object 'Chabo_L_M_5_9' 'Chabo_L_M_6_9' ...
  ...
$ ...
$ metric = RDM()
$ score = metric(assembly1=hvm, assembly2=hvm)
Score(aggregation: 2)>
array([1., 0.])
Coordinates:
  * aggregation    'center' 'error'

Some steps may take minutes because data has to be downloaded during first-time use.

More examples can be found in the examples directory.

Only necessary if you plan to change code.

1. If you want to access private S3 data, get permissions for the DiCarlo Lab Amazon S3 account
   1. The lab has several S3 accounts. You need to have access to the one numbered 613927419654. Ask Chris Shay to grant access to you
   2. Configure your AWS credentials files using awscli:
   3. Install awscli using pip install awscli
   4. Run aws configure: region: us-east-1, output format: json
2. Clone the Git repository to wherever you keep repositories:
   • cd ~/dev
   • git clone [email protected]:dicarlolab/brain-score.git
3. Install the depencies (we suggest doing this in a conda environment):
   • pip install -e .

MIT license