Merge branch 'develop'

Author: cezary.maszczyk

.gitignore

@@ -283,6 +283,7 @@ tests/resources
 
 *.pickle
 
+doc/doc_env/
 doc/build/html
 doc/build/html/.buildinfo
 doc/build/html/.buildinfo

README.md

@@ -38,13 +38,11 @@ from rulekit import RuleKit
 from rulekit.classification import RuleClassifier
 from sklearn.datasets import load_iris
 
-RuleKit.init()
- 
-x, y = load_iris(return_X_y=True)
+X, y = load_iris(return_X_y=True)
 
 clf = RuleClassifier()
-clf.fit(x, y)
-prediction = clf.predict(x)
+clf.fit(X, y)
+prediction = clf.predict(X)
 
 print(prediction)
 ```

doc/requirements.txt

@@ -1,8 +1,9 @@
-Sphinx==3.5.3
-sphinx-rtd-theme==0.5.1
-nbsphinx==0.8.2
-sphinx-copybutton==0.3.1
+Jinja2<3.1
+Sphinx==7.2.6
+sphinx-rtd-theme==2.0.0
+nbsphinx==0.9.3
+sphinx-copybutton==0.5.2
 ipykernel==5.5.0
-pandoc==1.0.2
+pandoc~=2.3
 ../
 

doc/source/conf.py

@@ -13,18 +13,20 @@
 import os
 import sys
 import re
+from datetime import datetime
 sys.path.insert(0, os.path.abspath('../..'))
 
 current_path = os.path.dirname(os.path.realpath(__file__))
 
+import rulekit
 
 # -- Project information -----------------------------------------------------
 
-project = 'rulekit'
-copyright = '2023, ADAA'
+project = f'rulekit v{rulekit.__VERSION__}'
+copyright = f'{datetime.now().year}, ADAA'
 
 release = open(f'{current_path}/../../rulekit/__init__.py', mode='r').read().strip()
-version_regex = r'__version__\s*=\s*\'{0,1}"{0,1}([^\'"]+)\'{0,1}"{0,1}'
+version_regex = r'__VERSION__\s*=\s*\'{0,1}"{0,1}([^\'"]+)\'{0,1}"{0,1}'
 release = re.search(version_regex, release)[1]
 master_doc = 'index'
 

doc/source/index.rst

@@ -20,5 +20,6 @@ All package models are writen to be compatible with scikit learn library.
    :caption: Table of contents:
 
    Quick start <./rst/quick_start.rst>
+   Whats new <./rst/whats_new.rst>
    Tutorials <./rst/tutorials.rst>
    Code documentation <./rst/autodoc.rst>

doc/source/rst/quick_start.rst

@@ -28,28 +28,6 @@ To check if everything was installed correctly call:
 
 It should run without errors and print package version.
 
-Initializing package
---------------------
-
-Before you start using any of rulelkit package functionality you need to initialize it first. This step should be done only
-once at the beginning of the program, no need to initialize before every usage.
-
-.. code-block:: python
-
-    from rulekit import RuleKit
-
-    RuleKit.init()
-  
-    print(RuleKit.version)
-
-If this step failed it probably means one of two things:
-
-- you do not have java installed on your computer. Run :code:`'java -version'` and check for error and JRE version (it should be 1.8.0)
-
-- there is no *'rulekit-*-all.jar'* file in *'jar'* directory of the package. You can get jar file from `here <https://github.com/adaa-polsl/RuleKit/releases>`_ (download file ending with *'-all.jar'*).
-
-If everything worked fine it should print RuleKit jar version on the screen. You may wonder what is the difference between this version and the one printed at the beginning of this section. The first one is a version of python wrapper itself whereas the second on is a version of the `RuleKit <https://github.com/adaa-polsl/RuleKit>`_ library that is being used by the wrapper.
-
 Package usage
 --------------------
 
@@ -65,9 +43,6 @@ Now we are finally ready to use rulekit package and its models.
     X=iris.data
     y=iris.target
 
-    # don't forget to call init!
-    RuleKit.init()
-
     classifier = RuleClassifier()
     classifier.fit(X, y)
 

doc/source/rst/tutorials/bmt.arff

@@ -312,7 +312,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -329,7 +329,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -459,9 +459,9 @@
        "  <tbody>\n",
        "    <tr>\n",
        "      <th>C2</th>\n",
-       "      <td>2.462655</td>\n",
-       "      <td>2.153342</td>\n",
-       "      <td>0.239038</td>\n",
+       "      <td>3.784658</td>\n",
+       "      <td>3.268134</td>\n",
+       "      <td>0.394257</td>\n",
        "      <td>178</td>\n",
        "      <td>5.005618</td>\n",
        "      <td>14.382022</td>\n",
@@ -477,9 +477,9 @@
        "    </tr>\n",
        "    <tr>\n",
        "      <th>Correlation</th>\n",
-       "      <td>2.600227</td>\n",
-       "      <td>2.167673</td>\n",
-       "      <td>0.411161</td>\n",
+       "      <td>3.130663</td>\n",
+       "      <td>2.592273</td>\n",
+       "      <td>0.492708</td>\n",
        "      <td>58</td>\n",
        "      <td>6.000000</td>\n",
        "      <td>54.293103</td>\n",
@@ -495,9 +495,9 @@
        "    </tr>\n",
        "    <tr>\n",
        "      <th>RSS</th>\n",
-       "      <td>2.868707</td>\n",
-       "      <td>2.345742</td>\n",
-       "      <td>0.503246</td>\n",
+       "      <td>3.186367</td>\n",
+       "      <td>2.761221</td>\n",
+       "      <td>0.402097</td>\n",
        "      <td>60</td>\n",
        "      <td>4.216667</td>\n",
        "      <td>46.200000</td>\n",
@@ -518,9 +518,9 @@
       "text/plain": [
        "             time_total_s  time_growing_s  time_pruning_s  rules_count  \\\n",
        "Measure                                                                  \n",
-       "C2               2.462655        2.153342        0.239038          178   \n",
-       "Correlation      2.600227        2.167673        0.411161           58   \n",
-       "RSS              2.868707        2.345742        0.503246           60   \n",
+       "C2               3.784658        3.268134        0.394257          178   \n",
+       "Correlation      3.130663        2.592273        0.492708           58   \n",
+       "RSS              3.186367        2.761221        0.402097           60   \n",
        "\n",
        "             conditions_per_rule  induced_conditions_per_rule  \\\n",
        "Measure                                                         \n",
@@ -1335,7 +1335,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -1388,15 +1388,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "time_total_s                     1.644584\n",
-       "time_growing_s                   1.443856\n",
-       "time_pruning_s                   0.174255\n",
+       "time_total_s                     1.843947\n",
+       "time_growing_s                   1.635322\n",
+       "time_pruning_s                   0.174192\n",
        "rules_count                    166.400000\n",
        "conditions_per_rule              4.947738\n",
        "induced_conditions_per_rule     13.622816\n",
@@ -1429,7 +1429,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [
     {
@@ -1479,7 +1479,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -1547,7 +1547,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [
     {