-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Add DesignEvaluator abstract base class
- Loading branch information
1 parent
b4d1100
commit a64009a
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
""" | ||
DesignEvaluator abstract base class for SLEDO. | ||
(c) Copyright UKAEA 2024. | ||
""" | ||
|
||
from abc import ABC, abstractmethod | ||
|
||
|
||
class DesignEvaluator(ABC): | ||
"""Abstract base class for evaluating a design. Must contain a method which | ||
takes in the parameters describing a design and returns the | ||
performance metrics for that design. Additional methods may be implemented | ||
by a given subclass to perform the design evaluation procedure as required. | ||
""" | ||
|
||
@abstractmethod | ||
def evaluate_design(self, parameters: dict) -> dict: | ||
"""Evaluate a design and return performance metrics. | ||
Parameters | ||
---------- | ||
parameters : dict | ||
Dictionary of parameters describing the design to be evaluated. | ||
Returns | ||
------- | ||
metrics: dict | ||
Dictionary of metrics describing the design's performance as | ||
evaluated. | ||
""" |