Skip to content

Commit

Permalink
Change default to us all cores.
Browse files Browse the repository at this point in the history
Expand on warning.
  • Loading branch information
morriscb committed Oct 6, 2023
1 parent 12521db commit 629f3e6
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -341,19 +341,19 @@ def get_raw_natural_movie(self) -> np.ndarray:
"""
return self.fetch_api.get_raw_natural_movie()

def get_natural_movie_template(self, n_workers=1) -> pd.DataFrame:
def get_natural_movie_template(self, n_workers=None) -> pd.DataFrame:
"""Download the movie if needed and process it into warped and unwarped
frames as presented to the mouse. The DataFrame is indexed with the
same frame index as shown in the stimulus presentation table.
The processing of the movie and its return size is very large so take
care in request this data.
The processing of the movie requires signicant processing and its
return size is very large so take care in requesting this data.
Parameters
----------
n_workers : int
Number of processes to use to transform the movie to what was shown
on the monitor. Default=1.
on the monitor. Default=None (use all cores).
Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,19 +281,19 @@ def get_raw_natural_movie(self) -> np.ndarray:
"""
return self._natural_movie_cache.get_raw_movie()

def get_natural_movie_template(self, n_workers=1) -> pd.DataFrame:
def get_natural_movie_template(self, n_workers=None) -> pd.DataFrame:
"""Download the movie if needed and process it into warped and unwarped
frames as presented to the mouse. The DataFrame is indexed with the
same frame index as shown in the stimulus presentation table.
The processing of the movie and its return size is very large so take
care in request this data.
The processing of the movie requires signicant processing and its
return size is very large so take care in requesting this data.
Parameters
----------
n_workers : int
Number of processes to use to transform the movie to what was shown
on the monitor. Default=1.
on the monitor. Default=None (use all cores).
Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,19 @@ def get_raw_movie(self):
"""
return np.load(self.download_data())

def get_processed_template_movie(self, n_workers=1):
def get_processed_template_movie(self, n_workers=None):
"""Download the movie if needed and process it into warped and unwarped
frames as presented to the mouse. The DataFrame is indexed with the
same frame index as shown in the stimulus presentation table.
The processing of the movie and its return size is very large so take
care in request this data.
The processing of the movie requires signicant processing and its
return size is very large so take care in requesting this data.
Parameters
----------
n_workers : int
Number of processes to use to transform the movie to what was shown
on the monitor. Default=1.
on the monitor. Default=None (use all cores).
Returns
-------
Expand Down

0 comments on commit 629f3e6

Please sign in to comment.