doc : Document updated #347

Document/Document.ipynb

@@ -2431,7 +2431,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "cp2 = Compare({\"cm2\":cm2,\"cm3\":cm3},by_class=True,weight={0:5,1:1,2:1})"
+    "cp2 = Compare({\"cm2\":cm2,\"cm3\":cm3},by_class=True,class_weight={0:5,1:1,2:1})"
    ]
   },
   {
@@ -2505,7 +2505,7 @@
    "source": [
     "1. `cm_dict` : python `dict` of `ConfusionMatrix` object (`str` : `ConfusionMatrix`)\n",
     "2. `by_class` : `bool`\n",
-    "3. `weight` : python `dict` of class weights (`class_name` : `float`)\n",
+    "3. `class_weight` : python `dict` of class weights (`class_name` : `float`)\n",
     "4. `digit`: `int`"
    ]
   },
@@ -2516,6 +2516,15 @@
     "* run `help(Compare)` for more information"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<ul>\n",
+    "    <li><span style=\"color:red;\">Notice </span> :  `weight` renamed to `class_weight` in <span style=\"color:red;\">version 3.3</span> </li>\n",
+    "</ul>"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -12785,7 +12794,7 @@
    ],
    "source": [
     "try:\n",
-    "    cp=Compare({\"cm1\":cm2,\"cm2\":cm3},by_class=True,weight={1:2,2:0})\n",
+    "    cp=Compare({\"cm1\":cm2,\"cm2\":cm3},by_class=True,class_weight={1:2,2:0})\n",
     "except pycmCompareError as e:\n",
     "    print(str(e))"
    ]

README.md

@@ -713,7 +713,7 @@ pycm.ConfusionMatrix(classes: [0, 1, 2])
 
 1. `cm_dict` : python `dict` of `ConfusionMatrix` object (`str` : `ConfusionMatrix`)
 2. `by_class` : `bool`
-3. `weight` : python `dict` of class weights (`class_name` : `float`)
+3. `class_weight` : python `dict` of class weights (`class_name` : `float`)
 4. `digit`: `int`
 
 * Run `help(Compare)` for `Compare` object details