Skip to content

Commit

Permalink
🖊️ extend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jvdd committed Oct 14, 2023
1 parent 1bb69cd commit e49b71a
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions tsflex/features/feature_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,8 @@ def _calculate_group_by_consecutive(
Whether the output needs to be a DataFrame or a list thereof, by default
False. If `True` the output dataframes will be merged to a DataFrame with an
outer merge.
**calculate_kwargs:
Keyword arguments that will be passed to the `calculate` method.
.. Note::
Is comparable to following pseudo-SQL code:
Expand Down Expand Up @@ -663,9 +665,25 @@ def _calculate_group_by_consecutive(

@staticmethod
def _process_njobs(n_jobs: Union[int, None], nb_funcs: int) -> int:
if (
os.name == "nt"
): # On Windows no multiprocessing is supported, see https://github.com/predict-idlab/tsflex/issues/51
"""Process the number of jobs to run in parallel.
On Windows no multiprocessing is supported, see
https://github.com/predict-idlab/tsflex/issues/51
Parameters
----------
n_jobs : Union[int, None]
The number of jobs to run in parallel.
nb_funcs : int
The number of feature functions.
Returns
-------
int
The number of jobs to run in parallel.
"""
if os.name == "nt": # On Windows no multiprocessing is supported
n_jobs = 1
elif n_jobs is None:
n_jobs = os.cpu_count()
Expand Down

0 comments on commit e49b71a

Please sign in to comment.