Refine some docstrings

benchmarks/definition/base.py

@@ -18,21 +18,21 @@
 
 @define(frozen=True, kw_only=True)
 class BenchmarkSettings(ABC, BenchmarkSerialization):
-    """Benchmark configuration for recommender analyses."""
+    """The basic benchmark configuration."""
 
     random_seed: int = field(validator=instance_of(int), default=1337)
-    """The random seed for reproducibility."""
+    """The used random seed."""
 
 
 BenchmarkSettingsType = TypeVar("BenchmarkSettingsType", bound=BenchmarkSettings)
 
 
 @define(frozen=True)
 class Benchmark(Generic[BenchmarkSettingsType], BenchmarkSerialization):
-    """The base class for a benchmark executable."""
+    """The base class for all benchmark definitions."""
 
     function: Callable[[BenchmarkSettingsType], DataFrame] = field()
-    """The callable which contains the benchmarking logic."""
+    """The callable containing the benchmarking logic."""
 
     settings: BenchmarkSettingsType = field()
     """The benchmark configuration."""

benchmarks/definition/convergence.py

@@ -27,7 +27,7 @@ class ConvergenceBenchmark(Benchmark[ConvergenceBenchmarkSettings]):
     """A class for defining convergence benchmarks."""
 
     best_possible_result: float | None = field(default=None)
-    """The best possible result which can be achieved in the optimization process."""
+    """The best possible result that can be achieved in the optimization process."""
 
     optimal_function_inputs: list[dict[str, Any]] | None = field(default=None)
-    """An input that creates the best_possible_result."""
+    """The optimal inputs to the system being optimized."""

benchmarks/result/metadata.py

@@ -27,7 +27,7 @@ class ResultMetadata(BenchmarkSerialization):
     """The latest BayBE tag reachable in the ancestor commit history."""
 
     branch: str = field(validator=instance_of(str), init=False)
-    """The branch currently checked out."""
+    """The branch checked out during benchmark execution."""
 
     @branch.default
     def _default_branch(self) -> str:

benchmarks/result/result.py

@@ -12,7 +12,7 @@
 
 @define(frozen=True)
 class Result(BenchmarkSerialization):
-    """A single result of the benchmarking."""
+    """A single benchmarking result."""
 
     benchmark_identifier: str = field(validator=instance_of(str))
     """The identifier of the benchmark that produced the result."""