Class swarmauri_standard.measurements.DistinctivenessMeasurement.DistinctivenessMeasurement
    
              Bases: MeasurementBase
Measurement for evaluating the distinctiveness of a dataset or collection of values. Distinctiveness is calculated as the percentage of unique non-null values relative to the total number of non-null values in the dataset.
| ATTRIBUTE | DESCRIPTION | 
|---|---|
| type | Type identifier for the measurement 
                  
                    TYPE:
                       | 
| unit | Unit of measurement (percentage) 
                  
                    TYPE:
                       | 
| value | Stores the calculated distinctiveness score 
                  
                    TYPE:
                       | 
class-attribute
      instance-attribute
  
type = 'DistinctivenessMeasurement'
class-attribute
      instance-attribute
  
unit = '%'
class-attribute
      instance-attribute
  
model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)
class-attribute
      instance-attribute
  
id = Field(default_factory=generate_id)
class-attribute
      instance-attribute
  
members = None
class-attribute
      instance-attribute
  
owners = None
class-attribute
      instance-attribute
  
host = None
class-attribute
  
default_logger = None
class-attribute
      instance-attribute
  
logger = None
class-attribute
      instance-attribute
  
name = None
class-attribute
      instance-attribute
  
resource = Field(default=MEASUREMENT.value, frozen=True)
class-attribute
      instance-attribute
  
version = '0.1.0'
class-attribute
      instance-attribute
  
value = None
calculate_distinctiveness(data)
Calculates the distinctiveness score for different data types.
| PARAMETER | DESCRIPTION | 
|---|---|
| data | Input data which can be a pandas DataFrame, List, or Dictionary 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| float | Distinctiveness score as a percentage (0-100) 
                  
                    TYPE:
                       | 
Source code in swarmauri_standard/measurements/DistinctivenessMeasurement.py
              | 23 24 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 56 57 58 59 60 61 |  | 
call(data, kwargs=None)
Calculates and returns the distinctiveness score for the provided data.
| PARAMETER | DESCRIPTION | 
|---|---|
| data | Input data to evaluate distinctiveness 
                  
                    TYPE:
                       | 
| kwargs | Additional parameters (reserved for future use) 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| float | Distinctiveness score as a percentage (0-100) 
                  
                    TYPE:
                       | 
Source code in swarmauri_standard/measurements/DistinctivenessMeasurement.py
              | 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |  | 
get_column_distinctiveness(df)
Calculate distinctiveness scores for individual columns in a DataFrame.
| PARAMETER | DESCRIPTION | 
|---|---|
| df | Input DataFrame 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| Dict[str, float] | Dict[str, float]: Dictionary mapping column names to their distinctiveness scores | 
Source code in swarmauri_standard/measurements/DistinctivenessMeasurement.py
              | 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |  | 
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 |  | 
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 |  | 
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(
    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 |  | 
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(
    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(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
              | 23 24 25 26 27 28 |  |