Cosmetic

Author: mdbenito

CHANGELOG.md

@@ -1,9 +1,11 @@
 # Changelog
 
-## 0.7.0 - 📚 Documentation overhaul, new methods and bug fixes 💥
+## 0.7.0 - 📚🆕 Documentation and IF overhaul, new methods and bug fixes 💥🐞
 
 This is our first β release! We have worked hard to deliver improvements across
-the board, with a focus on documentation and usability. 
+the board, with a focus on documentation and usability. We have also reworked
+the internals of the `influence` module, improved parallelism and handling of
+randomness.
 
 ### Added
 
@@ -19,6 +21,7 @@ the board, with a focus on documentation and usability.
   [PR #396](https://github.com/aai-institute/pyDVL/pull/396)
 
 ### Changed
+
 - Replaced sphinx with mkdocs for documentation. Major overhaul of documentation
   [PR #352](https://github.com/aai-institute/pyDVL/pull/352)
 - Made ray an optional dependency, relying on joblib as default parallel backend

src/pydvl/utils/functional.py

@@ -33,7 +33,8 @@ def _accept_additional_argument(*args, fun: Callable, arg: str, **kwargs):
 
 
 def free_arguments(fun: Union[Callable, partial]) -> Set[str]:
-    """Computes the set of free arguments for a function or [partial object][].
+    """Computes the set of free arguments for a function or
+    [functools.partial][] object.
 
     All arguments of a function are considered free unless they are set by a
     partial. For example, if `f = partial(g, a=1)`, then `a` is not a free
@@ -44,12 +45,15 @@ def free_arguments(fun: Union[Callable, partial]) -> Set[str]:
 
     Returns:
         The set of free arguments of `fun`.
+
+    !!! tip "New in version 0.7.0"
     """
     args_set_by_partial: Set[str] = set()
 
     def _rec_unroll_partial_function_args(g: Union[Callable, partial]) -> Callable:
-        """Stores arguments and recursively call itself if `g` is a partial. In
-        the end, returns the initially wrapped function.
+        """Stores arguments and recursively call itself if `g` is a
+        [functools.partial][] object. In the end, returns the initially wrapped
+        function.
 
         This handles the construct `partial(_accept_additional_argument, *args,
         **kwargs)` that is used by `maybe_add_argument`.
@@ -94,6 +98,9 @@ def maybe_add_argument(fun: Callable, new_arg: str) -> Callable:
 
     Returns:
         A new function accepting one more keyword argument.
+
+    !!! tip "Changed in version 0.7.0"
+        Ability to work with partials.
     """
     if new_arg in free_arguments(fun):
         return fun

src/pydvl/utils/parallel/map_reduce.py

@@ -15,13 +15,8 @@
 from numpy.typing import NDArray
 
 from ..config import ParallelConfig
-from ..types import (
-    MapFunction,
-    ReduceFunction,
-    Seed,
-    ensure_seed_sequence,
-)
 from ..functional import maybe_add_argument
+from ..types import MapFunction, ReduceFunction, Seed, ensure_seed_sequence
 from .backend import init_parallel_backend
 
 __all__ = ["MapReduceJob"]

src/pydvl/utils/types.py

@@ -9,7 +9,14 @@
 from numpy.random import Generator, SeedSequence
 from numpy.typing import NDArray
 
-__all__ = ["SupervisedModel", "MapFunction", "ReduceFunction", "NoPublicConstructor"]
+__all__ = [
+    "ensure_seed_sequence",
+    "MapFunction",
+    "NoPublicConstructor",
+    "ReduceFunction",
+    "Seed",
+    "SupervisedModel",
+]
 
 R = TypeVar("R", covariant=True)
 
@@ -83,6 +90,8 @@ def ensure_seed_sequence(
 
     Returns:
         A SeedSequence object.
+
+    !!! tip "New in version 0.7.0"
     """
     if isinstance(seed, SeedSequence):
         return seed

src/pydvl/value/loo/loo.py

@@ -32,7 +32,7 @@ def compute_loo(
     Returns:
         Object with the data values.
 
-    !!! tip "New in version 0.8.0"
+    !!! tip "New in version 0.7.0"
         Renamed from `naive_loo` and added parallel computation.
     """
 

src/pydvl/value/shapley/montecarlo.py

@@ -241,7 +241,8 @@ def _combinatorial_montecarlo_shapley(
     job_id: int = 1,
     seed: Optional[Seed] = None,
 ) -> ValuationResult:
-    """Helper function for [combinatorial_montecarlo_shapley()][pydvl.value.shapley.montecarlo.combinatorial_montecarlo_shapley].
+    """Helper function for
+    [combinatorial_montecarlo_shapley][pydvl.value.shapley.montecarlo.combinatorial_montecarlo_shapley].
 
     This is the code that is sent to workers to compute values using the
     combinatorial definition.
@@ -252,7 +253,8 @@ def _combinatorial_montecarlo_shapley(
         done: Check on the results which decides when to stop sampling
             subsets for an index.
         progress: Whether to display progress bars for each job.
-        seed: Either an instance of a numpy random number generator or a seed for it.
+        seed: Either an instance of a numpy random number generator or a seed
+            for it.
         job_id: id to use for reporting progress
 
     Returns: