sepandhaghighi/pycm

Improve docstring

sepandhaghighi opened this issue · 1 comments

Description

Improve and unify docstring

Examples :

    def print_matrix(self, one_vs_all=False, class_name=None, sparse=False):
        """
        Print confusion matrix.

        :param one_vs_all : One-Vs-All mode flag
        :type one_vs_all : bool
        :param class_name : target class name for One-Vs-All mode
        :type class_name : any valid type
        :param sparse : sparse mode printing flag
        :type sparse : bool
        :return: None
        """
    def save_stat(
            self,
            name,
            address=True,
            overall_param=None,
            class_param=None,
            class_name=None,
            summary=False,
            sparse=False):
        """
        Save ConfusionMatrix in .pycm (flat file format).

        :param name: filename
        :type name : str
        :param address: flag for address return
        :type address : bool
        :param overall_param : overall parameters list for save, Example : ["Kappa","Scott PI]
        :type overall_param : list
        :param class_param : class parameters list for save, Example : ["TPR","TNR","AUC"]
        :type class_param : list
        :param class_name : class name (sub set of classes), Example :[1,2,3]
        :type class_name : list
        :param summary : summary mode flag
        :type summary : bool
        :param sparse : sparse mode printing flag
        :type sparse : bool
        :return: saving status as dict {"Status":bool , "Message":str}
        """
  1. param, type and return description should be lowercase (Unless exceptions)
  2. Docstring description will begin with an uppercase letter and end with a dot