diff --git a/README.md b/README.md index d5d99a8..7a7e067 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,27 @@ # Rulekit - This package is python wrapper for [RuleKit](https://github.com/adaa-polsl/RuleKit) library - a versatile tool for rule learning. Based on a sequential covering induction algorithm, it is suitable for classification, regression, and survival problems. ## Installation -> **NOTE**: -This package is a wrapper for Java library, and requires Java Development Kit version 8 or later to be installed on the computer. Both Open JDK and Oracle implementations are supported. -## - ```bash pip install rulekit ``` + +> **NOTE**: +This package is a wrapper for Java library, and requires Java Development Kit version 8 or later to be installed on the computer. Both Open JDK and Oracle implementations are supported. + +If you don’t have JDK installed on your computer you can quickly set it up using install-jdk package. +``` +pip install install-jdk +``` +```python +import jdk +jdk.install('11', jre=True) +``` ## Running tests diff --git a/docs/HOW_TO_DEPLOY.md b/docs/HOW_TO_DEPLOY.md index dab03d0..a5d590e 100644 --- a/docs/HOW_TO_DEPLOY.md +++ b/docs/HOW_TO_DEPLOY.md @@ -28,7 +28,7 @@ In root repository directory: ``` rm -r ./dist python setup.py sdist -python -m twine check dist/* -python -m twine upload dist/* +python -m twine check ./dist/* +python -m twine upload ./dist/* ``` > For the last command use `__token__` as username and your token value as password when prompted. \ No newline at end of file diff --git a/docs/badges/coverage-badge.svg b/docs/badges/coverage-badge.svg index eb0ef9c..458d1a4 100644 --- a/docs/badges/coverage-badge.svg +++ b/docs/badges/coverage-badge.svg @@ -1 +1 @@ -coverage: 88.97%coverage88.97% \ No newline at end of file +coverage: 89.10%coverage89.10% \ No newline at end of file diff --git a/docs/badges/flake8-badge.svg b/docs/badges/flake8-badge.svg index cb00fa6..95f6c26 100644 --- a/docs/badges/flake8-badge.svg +++ b/docs/badges/flake8-badge.svg @@ -1 +1 @@ -flake8: 0 C, 3390 W, 0 Iflake80 C, 3390 W, 0 I \ No newline at end of file +flake8: 0 C, 7 W, 0 Iflake80 C, 7 W, 0 I \ No newline at end of file diff --git a/docs/badges/test-badge.svg b/docs/badges/test-badge.svg index 51143d6..37c07b2 100644 --- a/docs/badges/test-badge.svg +++ b/docs/badges/test-badge.svg @@ -1 +1 @@ -tests: 45tests45 \ No newline at end of file +tests: 46tests46 \ No newline at end of file diff --git a/docs/reports/coverage/class_index.html b/docs/reports/coverage/class_index.html index 2a5b9d8..2d394c2 100644 --- a/docs/reports/coverage/class_index.html +++ b/docs/reports/coverage/class_index.html @@ -55,7 +55,7 @@

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

@@ -81,32 +81,32 @@

100% - rulekit\_helpers.py - RuleGeneratorConfigurator + rulekit\_helpers.py + RuleGeneratorConfigurator 83 22 0 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 + rulekit\_helpers.py + ModelSerializer 11 1 0 @@ -115,10 +115,10 @@

rulekit\_helpers.py (no class) - 61 + 68 0 0 - 100% + 100% rulekit\_logging.py @@ -145,8 +145,8 @@

81% - rulekit\_operator.py - ExpertKnowledgeOperator + rulekit\_operator.py + ExpertKnowledgeOperator 25 1 0 @@ -193,56 +193,56 @@

100% - rulekit\classification.py - _ClassificationParams + rulekit\classification.py + _ClassificationParams 0 0 0 100% - rulekit\classification.py - _ClassificationExpertParams + rulekit\classification.py + _ClassificationExpertParams 0 0 0 100% - rulekit\classification.py - BaseClassifier + 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 3 0 94% - rulekit\classification.py - ExpertRuleClassifier + rulekit\classification.py + ExpertRuleClassifier 19 2 0 89% - rulekit\classification.py - ContrastSetRuleClassifier + rulekit\classification.py + ContrastSetRuleClassifier 31 31 0 @@ -329,8 +329,8 @@

100% - rulekit\main.py - RuleKit + rulekit\main.py + RuleKit 50 17 0 @@ -353,32 +353,32 @@

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 - ExpertModelParams + rulekit\params.py + ExpertModelParams 0 0 0 100% - rulekit\params.py - ContrastSetModelParams + rulekit\params.py + ContrastSetModelParams 0 0 0 @@ -417,16 +417,16 @@

80% - rulekit\regression.py - ExpertRuleRegressor + rulekit\regression.py + ExpertRuleRegressor 7 0 0 100% - rulekit\regression.py - ContrastSetRuleRegressor + rulekit\regression.py + ContrastSetRuleRegressor 13 13 0 @@ -449,32 +449,32 @@

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 @@ -521,56 +521,56 @@

100% - rulekit\survival.py - _SurvivalModelsParams + rulekit\survival.py + _SurvivalModelsParams 0 0 0 100% - rulekit\survival.py - _SurvivalExpertModelParams + rulekit\survival.py + _SurvivalExpertModelParams 0 0 0 100% - rulekit\survival.py - _BaseSurvivalRulesModel + rulekit\survival.py + _BaseSurvivalRulesModel 1 0 0 100% - rulekit\survival.py - SurvivalRules + rulekit\survival.py + SurvivalRules 38 8 0 79% - rulekit\survival.py - ExpertSurvivalRules + rulekit\survival.py + ExpertSurvivalRules 12 0 0 100% - rulekit\survival.py - _SurvivalContrastSetModelParams + rulekit\survival.py + _SurvivalContrastSetModelParams 0 0 0 100% - rulekit\survival.py - ContrastSetSurvivalRules + rulekit\survival.py + ContrastSetSurvivalRules 16 16 0 @@ -579,10 +579,10 @@

rulekit\survival.py (no class) - 55 + 63 0 0 - 100% + 100% tests\__init__.py @@ -593,24 +593,24 @@

100% - tests\test_classifier.py - TestClassifier + tests\test_classifier.py + TestClassifier 106 0 0 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 + tests\test_classifier.py + TestExperClassifier 34 0 0 @@ -619,10 +619,10 @@

tests\test_classifier.py (no class) - 35 + 38 1 0 - 97% + 97% tests\test_regression.py @@ -721,44 +721,44 @@

91% - tests\test_survival.py - TestKaplanMeierEstimator + tests\test_survival.py + TestKaplanMeierEstimator 9 0 0 100% - tests\test_survival.py - TestSurvivalRules + tests\test_survival.py + TestSurvivalRules 64 0 0 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 - TestExpertSurvivalRules - 19 + tests\test_survival.py + TestExpertSurvivalRules + 23 0 0 - 100% + 100% tests\test_survival.py (no class) - 32 + 35 1 0 - 97% + 97% tests\utils.py @@ -853,10 +853,10 @@

Total   - 2176 + 2201 240 0 - 89% + 89% @@ -868,7 +868,7 @@

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