return_as generator_unordered support

[apiszcz]

Is return_as generator_unordered supported in version 1.3.2 with Python 3.11?

Lib\site-packages\joblib\parallel.py", line 1209, in __init__
    raise ValueError(
ValueError: Expected `return_as` parameter to be a string equal to "list" or "generator", but got generator_unordered instead

==
CHANGES.rst: generator_unordered. In this case the results will be returned in the
CHANGES.rst: return_as=generator_unordered.
examples/parallel_generator.py:aggregation function), then using return_as='generator_unordered' can be
examples/parallel_generator.py:# the option return_as="generator_unordered", so that the results are
examples/parallel_generator.py:# return_as="generator_unordered", let's explcitly add delay in some of
examples/parallel_generator.py:# If we use return_as="generator_unordered", res will not enforce any
examples/parallel_generator.py: "return_as='generator_unordered'..."
examples/parallel_generator.py:res = Parallel(n_jobs=2, return_as="generator_unordered")(
examples/parallel_generator.py:# observed when using 'return_as="generator_unordered".
examples/parallel_generator.py: label='return_as="generator_unordered"'
joblib/parallel.py: return_as: str in {'list', 'generator', 'generator_unordered'},
joblib/parallel.py: If 'generator_unordered', the generator will immediately yield
joblib/parallel.py: if return_as not in {"list", "generator", "generator_unordered"}:
joblib/parallel.py: f',"generator" or "generator_unordered", but got {return_as} '
joblib/parallel.py: self.return_ordered = return_as != "generator_unordered"
joblib/test/test_parallel.py: # return_as parameter is set to 'generator_unordered'
joblib/test/test_parallel.py: result = Parallel(n_jobs=n_jobs, return_as="generator_unordered",
joblib/test/test_parallel.py:@parametrize('return_as', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as_1', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as_2', ["generator", "generator_unordered"])
joblib/test/test_parallel.py: if return_as_1 == "generator_unordered":
joblib/test/test_parallel.py: if return_as_2 == "generator_unordered":
joblib/test/test_parallel.py:@parametrize('return_as_1', ["generator", "generator_unordered"])
joblib/test/test_parallel.py:@parametrize('return_as_2', ["generator", "generator_unordered"])
joblib/test/test_parallel.py: if return_as_2 == "generator_unordered":

[apiszcz]

1.4dev0 is the first version with support.

In development

• Ensure that errors in the task generator given to Parallel's call
  are raised in the results consumming thread.
  FIX raise iterator exception in user's thread #1491

• Adjust codebase to NumPy 2.0 by changing np.NaN to np.nan
  and importing byte_bounds from np.lib.array_utils.
  MAINT: Update byte_bounds import #1501

• The parameter return_as in joblib.Parallel can now be set to
  generator_unordered. In this case the results will be returned in the
  order of task completion rather than the order of submission.
  FEA Implement generator unordered parameter #1463

• dask backend now supports return_as=generator and
  return_as=generator_unordered.
  Update dask backend for compatibility with return_as=generator #1520

• Vendor cloudpickle 3.0.0 and end support for Python 3.7 which has
  reached end of life.
  MTN update ci pipelines to use python3.8 + test more pypy versions #1487
  Vendor cloudpickle 3.0.0 and drop support for Python 3.7. #1515