diff --git a/docs/badges/coverage-badge.svg b/docs/badges/coverage-badge.svg index 1024b0e..eb0ef9c 100644 --- a/docs/badges/coverage-badge.svg +++ b/docs/badges/coverage-badge.svg @@ -1 +1 @@ -coverage: 88.14%coverage88.14% \ No newline at end of file +coverage: 88.97%coverage88.97% \ No newline at end of file diff --git a/docs/badges/flake8-badge.svg b/docs/badges/flake8-badge.svg index 5975b02..cb00fa6 100644 --- a/docs/badges/flake8-badge.svg +++ b/docs/badges/flake8-badge.svg @@ -1 +1 @@ -flake8: 1 C, 8941 W, 0 Iflake81 C, 8941 W, 0 I \ No newline at end of file +flake8: 0 C, 3390 W, 0 Iflake80 C, 3390 W, 0 I \ No newline at end of file diff --git a/docs/badges/test-badge.svg b/docs/badges/test-badge.svg index 63a0abd..51143d6 100644 --- a/docs/badges/test-badge.svg +++ b/docs/badges/test-badge.svg @@ -1 +1 @@ -tests: 36tests36 \ No newline at end of file +tests: 45tests45 \ No newline at end of file diff --git a/docs/generate_readme_badges.py b/docs/generate_readme_badges.py index 56f7f5c..b40c359 100644 --- a/docs/generate_readme_badges.py +++ b/docs/generate_readme_badges.py @@ -10,71 +10,124 @@ # Documentation will be automatically generated on new version release def generate_tests_coverage_badge(cwd: str): - run_command([ - sys.executable, "-m", "coverage", "run", "-m", "unittest", "discover", "./tests" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "coverage", + "run", + "-m", + "unittest", + "discover", + "./tests", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "coverage", "xml", "-o", "./docs/reports/coverage/coverage.xml" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "coverage", + "xml", + "-o", + "./docs/reports/coverage/coverage.xml", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "coverage", "html", "-d", "./docs/reports/coverage/" - ], - cwd=cwd + run_command( + [sys.executable, "-m", "coverage", "html", "-d", "./docs/reports/coverage/"], + cwd=cwd, ) - run_command([ - "genbadge", "coverage", "-i", "./docs/reports/coverage/coverage.xml", "-o", "./docs/badges/coverage-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "coverage", + "-i", + "./docs/reports/coverage/coverage.xml", + "-o", + "./docs/badges/coverage-badge.svg", + ], + cwd=cwd, ) def generate_test_badge(cwd: str): - test_report_path = pathlib.Path(curr_dir_path / 'reports' / 'junit') + test_report_path = pathlib.Path(curr_dir_path / "reports" / "junit") shutil.rmtree(test_report_path) os.makedirs(test_report_path, exist_ok=True) - run_command([ - sys.executable, "-m", "junitxml.main", "--o", "./docs/reports/junit/junit.xml" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "junitxml.main", + "--o", + "./docs/reports/junit/junit.xml", + ], + cwd=cwd, ) - run_command([ - sys.executable, "-m", "junit2htmlreport", "./docs/reports/junit/junit.xml", "./docs/reports/junit/report.html" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "junit2htmlreport", + "./docs/reports/junit/junit.xml", + "./docs/reports/junit/report.html", + ], + cwd=cwd, ) - run_command([ - "genbadge", "tests", "-i", "./docs/reports/junit/junit.xml", "-o", "./docs/badges/test-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "tests", + "-i", + "./docs/reports/junit/junit.xml", + "-o", + "./docs/badges/test-badge.svg", + ], + cwd=cwd, ) def generate_flake8_badge(cwd: str): - run_command([ - sys.executable, "-m", "flake8", "./rulekit", "--exit-zero", "--format=html", "--htmldir", "./docs/reports/flake8", "--statistics", "--tee", "--output-file", "./docs/reports/flake8/flake8stats.txt" - ], - cwd=cwd + run_command( + [ + sys.executable, + "-m", + "flake8", + "./rulekit", + "--exit-zero", + "--format=html", + "--htmldir", + "./docs/reports/flake8", + "--statistics", + "--tee", + "--output-file", + "./docs/reports/flake8/flake8stats.txt", + ], + cwd=cwd, ) - run_command([ - "genbadge", "flake8", "-i", "./docs/reports/flake8/flake8stats.txt", "-o", "./docs/badges/flake8-badge.svg" - ], - cwd=cwd + run_command( + [ + "genbadge", + "flake8", + "-i", + "./docs/reports/flake8/flake8stats.txt", + "-o", + "./docs/badges/flake8-badge.svg", + ], + cwd=cwd, ) def main(): - print('Updating badges') - cwd = pathlib.Path(curr_dir_path / '..') # root repo dir + print("Updating badges") + cwd = pathlib.Path(curr_dir_path / "..") # root repo dir - # generate_tests_coverage_badge(cwd) - # generate_test_badge(cwd) + generate_tests_coverage_badge(cwd) + generate_test_badge(cwd) generate_flake8_badge(cwd) - print('Badges generated successfully!') + print("Badges generated successfully!") if __name__ == "__main__": diff --git a/docs/reports/coverage/class_index.html b/docs/reports/coverage/class_index.html index ba3b712..2a5b9d8 100644 --- a/docs/reports/coverage/class_index.html +++ b/docs/reports/coverage/class_index.html @@ -11,7 +11,7 @@

Coverage report: - 88% + 89%

@@ -83,42 +83,42 @@

rulekit\_helpers.py RuleGeneratorConfigurator - 66 - 14 + 83 + 22 0 - 79% + 73% - rulekit\_helpers.py - ExampleSetFactory + rulekit\_helpers.py + ExampleSetFactory 65 11 0 83% - rulekit\_helpers.py - PredictionResultMapper + rulekit\_helpers.py + PredictionResultMapper 33 4 0 88% - rulekit\_helpers.py - ModelSerializer - 9 - 0 + rulekit\_helpers.py + ModelSerializer + 11 + 1 0 - 100% + 91% rulekit\_helpers.py (no class) - 59 + 61 0 0 - 100% + 100% rulekit\_logging.py @@ -137,16 +137,16 @@

100% - rulekit\_operator.py - BaseOperator + rulekit\_operator.py + BaseOperator 52 10 0 81% - rulekit\_operator.py - ExpertKnowledgeOperator + rulekit\_operator.py + ExpertKnowledgeOperator 25 1 0 @@ -155,10 +155,10 @@

rulekit\_operator.py (no class) - 35 + 44 0 0 - 100% + 100% rulekit\_problem_types.py @@ -185,56 +185,64 @@

87% - rulekit\classification.py - ClassificationPredictionMetrics + rulekit\classification.py + ClassificationPredictionMetrics 0 0 0 100% - rulekit\classification.py - _ClassificationParams + rulekit\classification.py + _ClassificationParams 0 0 0 100% - rulekit\classification.py - BaseClassifier + rulekit\classification.py + _ClassificationExpertParams + 0 + 0 + 0 + 100% + + + rulekit\classification.py + BaseClassifier 8 0 0 100% - rulekit\classification.py - BaseClassifier.MetricTypes + rulekit\classification.py + BaseClassifier.MetricTypes 0 0 0 100% - rulekit\classification.py - RuleClassifier + rulekit\classification.py + RuleClassifier 52 - 5 + 3 0 - 90% + 94% - rulekit\classification.py - ExpertRuleClassifier + rulekit\classification.py + ExpertRuleClassifier 19 2 0 89% - rulekit\classification.py - ContrastSetRuleClassifier + rulekit\classification.py + ContrastSetRuleClassifier 31 31 0 @@ -243,22 +251,22 @@

rulekit\classification.py (no class) - 63 + 75 0 0 - 100% + 100% - rulekit\events.py - RuleInductionProgressListener + rulekit\events.py + RuleInductionProgressListener 1 0 0 100% - rulekit\events.py - command_listener_factory._CommandListener + rulekit\events.py + _command_listener_factory._CommandListener 4 0 0 @@ -267,42 +275,42 @@

rulekit\events.py (no class) - 18 + 22 0 0 - 100% + 100% - rulekit\exceptions.py - RuleKitJavaException + rulekit\exceptions.py + RuleKitJavaException 5 5 0 0% - rulekit\exceptions.py - RuleKitMisconfigurationException - 16 - 16 + rulekit\exceptions.py + RuleKitMisconfigurationException + 17 + 17 0 - 0% + 0% rulekit\exceptions.py (no class) - 14 + 15 0 0 - 100% + 100% rulekit\kaplan_meier.py KaplanMeierEstimator 19 - 1 0 - 95% + 0 + 100% rulekit\kaplan_meier.py @@ -313,16 +321,16 @@

100% - rulekit\main.py - JRE_Type + rulekit\main.py + JRE_Type 0 0 0 100% - rulekit\main.py - RuleKit + rulekit\main.py + RuleKit 50 17 0 @@ -331,30 +339,46 @@

rulekit\main.py (no class) - 37 + 39 0 0 - 100% + 100% + + + rulekit\params.py + _user_defined_measure_factory._UserMeasure + 1 + 1 + 0 + 0% - rulekit\params.py - Measures + rulekit\params.py + Measures 0 0 0 100% - rulekit\params.py - ModelsParams + rulekit\params.py + ModelsParams 0 0 0 100% - rulekit\params.py - ContrastSetModelParams + rulekit\params.py + ExpertModelParams + 0 + 0 + 0 + 100% + + + rulekit\params.py + ContrastSetModelParams 0 0 0 @@ -363,38 +387,46 @@

rulekit\params.py (no class) - 73 + 87 + 6 + 0 + 93% + + + rulekit\regression.py + _RegressionModelParams 0 0 - 100% + 0 + 100% - rulekit\regression.py - _RegressionParams + rulekit\regression.py + _RegressionExpertModelParams 0 0 0 100% - rulekit\regression.py - RuleRegressor + rulekit\regression.py + RuleRegressor 15 3 0 80% - rulekit\regression.py - ExpertRuleRegressor + rulekit\regression.py + ExpertRuleRegressor 7 0 0 100% - rulekit\regression.py - ContrastSetRuleRegressor + rulekit\regression.py + ContrastSetRuleRegressor 13 13 0 @@ -403,54 +435,54 @@

rulekit\regression.py (no class) - 37 + 47 0 0 - 100% + 100% - rulekit\rules.py - InductionParameters + rulekit\rules.py + InductionParameters 14 14 0 0% - rulekit\rules.py - BaseRule + rulekit\rules.py + BaseRule 14 2 0 86% - rulekit\rules.py - ClassificationRule + rulekit\rules.py + ClassificationRule 3 1 0 67% - rulekit\rules.py - RegressionRule + rulekit\rules.py + RegressionRule 3 1 0 67% - rulekit\rules.py - SurvivalRule + rulekit\rules.py + SurvivalRule 3 0 0 100% - rulekit\rules.py - RuleSet + rulekit\rules.py + RuleSet 30 3 0 @@ -459,10 +491,10 @@

rulekit\rules.py (no class) - 82 + 85 0 0 - 100% + 100% rulekit\stats.py @@ -489,44 +521,60 @@

100% - rulekit\survival.py - SurvivalModelsParams + rulekit\survival.py + _SurvivalModelsParams 0 0 0 100% - rulekit\survival.py - SurvivalRules - 37 - 22 + rulekit\survival.py + _SurvivalExpertModelParams + 0 0 - 41% + 0 + 100% - rulekit\survival.py - ExpertSurvivalRules - 11 + rulekit\survival.py + _BaseSurvivalRulesModel + 1 0 0 - 100% + 100% + + + rulekit\survival.py + SurvivalRules + 38 + 8 + 0 + 79% + + + rulekit\survival.py + ExpertSurvivalRules + 12 + 0 + 0 + 100% - rulekit\survival.py - SurvivalContrastSetModelParams + rulekit\survival.py + _SurvivalContrastSetModelParams 0 0 0 100% - rulekit\survival.py - ContrastSetSurvivalRules - 15 - 15 + rulekit\survival.py + ContrastSetSurvivalRules + 16 + 16 0 - 0% + 0% rulekit\survival.py @@ -547,66 +595,66 @@

tests\test_classifier.py TestClassifier - 92 + 106 0 0 - 100% + 100% - tests\test_classifier.py - TestClassifier.test_induction_progress_listener.EventListener + tests\test_classifier.py + TestClassifier.test_induction_progress_listener.EventListener 6 0 0 100% - tests\test_classifier.py - TestExperClassifier - 28 + tests\test_classifier.py + TestExperClassifier + 34 0 0 - 100% + 100% tests\test_classifier.py (no class) - 33 + 35 1 0 - 97% + 97% - tests\test_regression.py - TestRegressor + tests\test_regression.py + TestRegressor 47 0 0 100% - tests\test_regression.py - TestRegressor.test_induction_progress_listener.EventListener + tests\test_regression.py + TestRegressor.test_induction_progress_listener.EventListener 10 0 0 100% - tests\test_regression.py - TestExpertRegressor - 12 + tests\test_regression.py + TestExpertRegressor + 28 0 0 - 100% + 100% tests\test_regression.py (no class) - 25 + 31 1 0 - 96% + 97% tests\test_rulekit.py @@ -673,48 +721,48 @@

91% - tests\test_survival.py - TestKaplanMeierEstimator + tests\test_survival.py + TestKaplanMeierEstimator 9 0 0 100% - tests\test_survival.py - TestSurvivalRules - 35 + tests\test_survival.py + TestSurvivalRules + 64 0 0 - 100% + 100% - tests\test_survival.py - TestSurvivalRules.test_induction_progress_listener.EventListener + tests\test_survival.py + TestSurvivalRules.test_induction_progress_listener.EventListener 6 0 0 100% - tests\test_survival.py - TestExpertSurvivalLogRankTree - 11 + tests\test_survival.py + TestExpertSurvivalRules + 19 0 0 - 100% + 100% tests\test_survival.py (no class) - 26 + 32 1 0 - 96% + 97% - tests\utils.py - ExampleSetWrapper + tests\utils.py + ExampleSetWrapper 4 1 0 @@ -745,48 +793,48 @@

100% - tests\utils.py - DataSetConfig + tests\utils.py + DataSetConfig 4 0 0 100% - tests\utils.py - TestConfig + tests\utils.py + TestConfig 3 0 0 100% - tests\utils.py - TestConfigParser + tests\utils.py + TestConfigParser 62 6 0 90% - tests\utils.py - TestCaseFactory + tests\utils.py + TestCaseFactory 50 2 0 96% - tests\utils.py - TestReportReader + tests\utils.py + TestReportReader 20 2 0 90% - tests\utils.py - TestReportWriter + tests\utils.py + TestReportWriter 8 8 0 @@ -795,20 +843,20 @@

tests\utils.py (no class) - 146 - 12 + 147 + 13 0 - 92% + 91% Total   - 2006 - 238 + 2176 + 240 0 - 88% + 89% @@ -820,7 +868,7 @@

coverage.py v7.6.4, - created at 2024-11-08 14:43 +0100 + created at 2024-11-28 12:33 +0100