Skip to content

Inspectors

Common abstractions for inspectors

TesterSignatureSpec

Bases: BaseModel

Source code in src/fed_rag/inspectors/common.py 
14
15
16
17
18
19
20
21
class TesterSignatureSpec(BaseModel):
    __test__ = (
        False  # needed for Pytest collision. Avoids PytestCollectionWarning
    )
    net_parameter: str
    test_data_param: str
    extra_test_kwargs: list[str] = []
    net_parameter_class_name: str

TesterSignatureSpec

Bases: BaseModel

Source code in src/fed_rag/inspectors/common.py 
14
15
16
17
18
19
20
21
class TesterSignatureSpec(BaseModel):
    __test__ = (
        False  # needed for Pytest collision. Avoids PytestCollectionWarning
    )
    net_parameter: str
    test_data_param: str
    extra_test_kwargs: list[str] = []
    net_parameter_class_name: str

Data structures for results

TrainResult

Bases: BaseModel

Source code in src/fed_rag/data_structures/results.py 
8
9
class TrainResult(BaseModel):
    loss: float

TestResult

Bases: BaseModel

Source code in src/fed_rag/data_structures/results.py 
12
13
14
15
16
17
18
19
20
class TestResult(BaseModel):
    __test__ = (
        False  # needed for Pytest collision. Avoids PytestCollectionWarning
    )
    loss: float
    metrics: dict[str, Any] = Field(
        description="Additional metrics computed on test set.",
        default_factory=dict,
    )