Merge pull request #22 from arogozhnikov/dev

improvements in the documentation
arogozhnikov · May 15, 2023 · a253721 · a253721
2 parents 45e351f + 2353cb0
commit a253721
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 # eindex
 
-Multidimensional indexing for tensors
+Concept of multidimensional indexing for tensors
 
 
 ## Example of K-means clustering
@@ -23,9 +23,8 @@ def kmeans(init_centers, X, n_iterations: int):
         clusters = np.argmin(d, axis=0)            
         new_centers_sum = np.zeros_like(centers)
         clstr_indices = np.tile(clusters[:, None], reps=(1, n_dim))
-        dim___indices = np.tile(np.arange(n_dim)[None, :], 
-                                reps=(n_onservations, 1))
-        np.add.at(new_centers_sum, (clstr_indices, dim___indices), X)
+        dim_indices = np.tile(np.arange(n_dim)[None, :], reps=(n_onservations, 1))
+        np.add.at(new_centers_sum, (clstr_indices, dim_indices), X)
         cluster_counts = np.bincount(clusters, minlength=n_clusters)
         centers = new_centers_sum / cluster_counts[:, None]
     return centers
@@ -40,7 +39,7 @@ def kmeans_eindex(init_centers, X, n_iterations: int):
     for _ in range(n_iterations):
         d = cdist(centers, X)
         clusters = EX.argmin(d, 'cluster i -> [cluster] i')
-        centers = EX.scatter('i c, [cluster] i  -> cluster c', X, clusters, 
+        centers = EX.scatter(X, clusters, 'i c, [cluster] i -> cluster c',  
                              agg='mean', cluster=len(centers))
     return centers
 ```

diff --git a/tutorial/data.py b/tutorial/data.py
@@ -16,9 +16,9 @@ def __init__(self):
             "Yoda",
             "Alice",
             "Gandalf",
-            "R. Daneel Olivaw",
+            "Harry Potter-Verres",
             "Devola & Popola",
-            # "Harry James Potter-Evans-Verres",
+            # "R. Daneel Olivaw",
             # Aerith,
             # Aloy,
         ]

diff --git a/tutorial/tutorial.ipynb b/tutorial/tutorial.ipynb
@@ -109,7 +109,7 @@
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'>Yoda</div>\n",
        "<div style='grid-column: col1 / span 1 ; grid-row: rowname / span 1;'>Alice</div>\n",
        "<div style='grid-column: col2 / span 1 ; grid-row: rowname / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: col3 / span 1 ; grid-row: rowname / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: col3 / span 1 ; grid-row: rowname / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: col4 / span 1 ; grid-row: rowname / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: row0 / span 1; '>Amber, City Center</div>\n",
        "<div style='grid-column: col1 / span 1 ; grid-row: row0 / span 1; '>Amber, City Center</div>\n",
@@ -173,6 +173,13 @@
     "data.visualize(data.travels, '[world, place] hero year month', cols='hero', rows='year month')"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Important:** If above does not look like a table, but more like a list, you need to rerun notebook, or trust the notebook."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 5,
@@ -1401,7 +1408,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'>2020<br />\n",
        " August</div>\n",
@@ -1684,7 +1691,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'>2020</div>\n",
        "<div style='grid-column: col1 / span 1 ; grid-row: rowname / span 1;'>2021</div>\n",
@@ -1749,7 +1756,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'>2020</div>\n",
        "<div style='grid-column: col1 / span 1 ; grid-row: rowname / span 1;'>2021</div>\n",
@@ -1788,7 +1795,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'></div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: row0 / span 1;  text-align: right;'>-18.1</div>\n",
@@ -1857,7 +1864,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'>2020<br />\n",
        " August</div>\n",
@@ -2642,7 +2649,7 @@
        "            <div style='grid-column: colname / span 1 ; grid-row: row0 / span 1;'>Yoda</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row1 / span 1;'>Alice</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row2 / span 1;'>Gandalf</div>\n",
-       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry James Potter-Evans-Verres</div>\n",
+       "<div style='grid-column: colname / span 1 ; grid-row: row3 / span 1;'>Harry Potter-Verres</div>\n",
        "<div style='grid-column: colname / span 1 ; grid-row: row4 / span 1;'>Devola & Popola</div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: rowname / span 1;'></div>\n",
        "<div style='grid-column: col0 / span 1 ; grid-row: row0 / span 1;  text-align: right;'>2</div>\n",