mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-08-03 18:27:43 +00:00
WinstonLiyt
cdc93bf630
* Fixed some bugs introduced during refactoring. * Add description for scenario experiments. * Update factor_from_report_w_sc.py * fix some ci bugs. * add @property to get_experiment_setting * fix a ci error.
42 lines
1004 B
Python
42 lines
1004 B
Python
from abc import ABC, abstractmethod
|
|
|
|
|
|
class Scenario(ABC):
|
|
@property
|
|
@abstractmethod
|
|
def background(self) -> str:
|
|
"""Background information"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def source_data(self) -> str:
|
|
"""Source data description"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def interface(self) -> str:
|
|
"""Interface description about how to run the code"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def output_format(self) -> str:
|
|
"""Output format description"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def simulator(self) -> str:
|
|
"""Simulator description"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def rich_style_description(self) -> str:
|
|
"""Rich style description to present"""
|
|
|
|
@abstractmethod
|
|
def get_scenario_all_desc(self) -> str:
|
|
"""Combine all the description together"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def get_experiment_setting(self) -> str:
|
|
"""Get experiment setting and return as rich text string""" |