add BRAINSCORE_HOME to docs

Open Beginner friendly
#583 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Locate the documentation covering Brain-Score configuration or result storage; no specific file or test is named in the issue. Add the BRAINSCORE_HOME export example and explain that it sets a custom directory for stored results. Done means users can find and understand how to avoid storing results in the default home directory.

Written by the indexing model from the issue text.

Description

From @ShreyaKapoor18 in https://github.com/brain-score/vision/issues/533#issuecomment-1959217245:

One thing I'd like to mention is that maybe it is helpful to add the following things to the documentation
export BRAINSCORE_HOME="/path/to/custom/brainscore/dir"
since the brain score results were being stored in the $HOME (with limited memory) directory for my cluster storage by default.

Dominant language
Python
Stars
193
Forks
105
Avg merge
10h 48m
Merged PRs (30d)
10

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from brain-score/vision

All issues in brain-score/vision

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.