Class swarmauri_distance_minkowski.MinkowskiDistance.MinkowskiDistance
swarmauri_distance_minkowski.MinkowskiDistance.MinkowskiDistance
Bases: DistanceBase
Implementation of the IDistanceSimiliarity interface using the Minkowski distance metric. Minkowski distance is a generalized metric form that includes Euclidean distance, Manhattan distance, and others depending on the order (p) parameter.
The class provides methods to compute the Minkowski distance between two vectors.
- p (int): The order of the Minkowski distance. p=2 corresponds to the Euclidean distance, while p=1 corresponds to the Manhattan distance. Default is 2.
type
class-attribute
instance-attribute
type = 'MinkowskiDistance'
p
class-attribute
instance-attribute
p = 2
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
name
class-attribute
instance-attribute
name = None
version
class-attribute
instance-attribute
version = '0.1.0'
distance
distance(vector_a, vector_b)
Computes the Minkowski distance between two vectors.
PARAMETER | DESCRIPTION |
---|---|
vector_a
|
The first vector in the comparison.
TYPE:
|
vector_b
|
The second vector in the comparison.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
float
|
The computed Minkowski distance between vector_a and vector_b.
TYPE:
|
Source code in swarmauri_distance_minkowski/MinkowskiDistance.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
|
similarity
similarity(vector_a, vector_b)
Compute the similarity between two vectors based on the Minkowski distance. The similarity is inversely related to the distance.
PARAMETER | DESCRIPTION |
---|---|
vector_a
|
The first vector to compare for similarity.
TYPE:
|
vector_b
|
The second vector to compare with the first vector.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
float
|
A similarity score between vector_a and vector_b.
TYPE:
|
Source code in swarmauri_distance_minkowski/MinkowskiDistance.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|
distances
distances(vector_a, vectors_b)
Source code in swarmauri_distance_minkowski/MinkowskiDistance.py
69 70 71 |
|
similarities
similarities(vector_a, vectors_b)
Source code in swarmauri_distance_minkowski/MinkowskiDistance.py
73 74 75 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|