From 00156b72beb668ac196dc29bf7ec8cd7c36a88e8 Mon Sep 17 00:00:00 2001 From: bxdd Date: Mon, 30 Oct 2023 15:45:02 +0800 Subject: [PATCH] [DOC] add docstring --- learnware/specification/base.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/learnware/specification/base.py b/learnware/specification/base.py index b689d41..2935a26 100644 --- a/learnware/specification/base.py +++ b/learnware/specification/base.py @@ -6,7 +6,15 @@ from typing import Dict class BaseStatSpecification: """The Statistical Specification Interface, which provide save and load method""" - def __init__(self, type): + def __init__(self, type: str): + """initilize the type of stats specification, current the type only supports the following values: + - 'table_rkme': the RKME specification for table dataset + + Parameters + ---------- + type : str + the type of the stats specification + """ self.type = type def generate_stat_spec_from_data(self, **kwargs):