Skip to content

Commit 87ab09c

Browse files
g-despotclaude
andcommitted
docs: simplify Boost modifier docstring wording
Replace flowery phrasing ("span many orders of magnitude", "long-tail dampening") with plain language describing what the LOG1P/SQRT modifiers do. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ff268ea commit 87ab09c

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

  • weaviate/collections/classes

weaviate/collections/classes/grpc.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -359,12 +359,12 @@ class _BoostCurve(str, BaseEnum):
359359
class _BoostModifier(str, BaseEnum):
360360
"""The transform applied to a numeric property's value in `numeric_property` before normalization.
361361
362-
Use a modifier to dampen values that span many orders of magnitude. If no modifier is
362+
Use a modifier to reduce the impact of large property values. If no modifier is
363363
set, the raw value is used.
364364
365365
Attributes:
366-
LOG1P: Apply `log(1 + value)` for strong long-tail dampening.
367-
SQRT: Apply `sqrt(value)` for milder long-tail dampening.
366+
LOG1P: Apply `log(1 + value)` to strongly reduce the impact of large values.
367+
SQRT: Apply `sqrt(value)` to mildly reduce the impact of large values.
368368
"""
369369

370370
LOG1P = "log1p"

0 commit comments

Comments
 (0)