Fix doc

Neuraxio · Oct 16, 2021 · 871654d · 871654d
1 parent e9cc89d
commit 871654d
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 8 deletions.
diff --git a/examples/Handler Methods.ipynb b/examples/Handler Methods.ipynb
@@ -13,7 +13,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![Neuraxle Handler Methods](./images/neuraxle_handler_methods.png)"
+    "![Neuraxle Handler Methods](./_images/neuraxle_handler_methods.png)"
    ]
   },
   {
@@ -37,6 +37,7 @@
     "2. [\\_will\\_fit(data_container, context)](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base._FittableStep._will_fit): Apply side effects before fit.\n",
     "3. [\\_fit\\_data\\_container(data_container, context)](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base._FittableStep._fit_data_container): Fit data container.\n",
     "4. [\\_did\\_fit(data_container, context)](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base._FittableStep._did_fit): Apply side effects after fit.\n",
+    "5. [\\_did\\_process(data_container, context)](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base._TransformerStep._did_process): Apply side effects after any step method.\n",
     "\n",
     "### [handle_transform](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base._TransformerStep.handle_transform)\n",
     "\n",
@@ -50,11 +51,11 @@
     "\n",
     "When you need to apply side effects, or change the execution flow:\n",
     "\n",
-    "- Edit the [DataContainer](https://www.neuraxle.org/stable/api/neuraxle.data_container.html#neuraxle.data_container.DataContainer)\n",
-    "- Call a method on a step\n",
-    "- Mini-Batching (see [MiniBatchSequentialPipeline](https://www.neuraxle.org/stable/api/neuraxle.pipeline.html#neuraxle.pipeline.MiniBatchSequentialPipeline))\n",
-    "- Caching (see [neuraxle.checkpoint](https://www.neuraxle.org/stable/api/neuraxle.checkpoints.html) package)\n",
-    "- etc.\n",
+    "* Edit the [DataContainer](https://www.neuraxle.org/stable/api/neuraxle.data_container.html#neuraxle.data_container.DataContainer)\n",
+    "* Call a method on a step\n",
+    "* Mini-Batching (see [MiniBatchSequentialPipeline](https://www.neuraxle.org/stable/api/neuraxle.pipeline.html#neuraxle.pipeline.MiniBatchSequentialPipeline))\n",
+    "* Caching (see [neuraxle.checkpoint](https://www.neuraxle.org/stable/api/neuraxle.checkpoints.html) package)\n",
+    "* etc.\n",
     "\n",
     "### [HandleOnlyMixin](https://www.neuraxle.org/stable/api/neuraxle.base.html#neuraxle.base.HandleOnlyMixin)\n",
     "\n",

diff --git a/examples/Introduction to Time Series Processing.ipynb b/examples/Introduction to Time Series Processing.ipynb
@@ -50,7 +50,7 @@
     "\n",
     "Here is how the 3D data cube looks like. So we'll have a train and a test data cube, and might create validation data cubes as well: \n",
     "\n",
-    "![](images/time-series-data.jpg)\n",
+    "![Time Series Data](./_images/neuraxle_time_series_data.png)\n",
     "\n",
     "So we have 3D data of shape `[batch_size, time_steps, features]`. If this and the above is still unclear to you, you may want to [learn more on the 3D shape of time series data](https://www.quora.com/What-do-samples-features-time-steps-mean-in-LSTM/answers/79038267).\n"
    ]

diff --git a/examples/Step Saving And Lifecycle.ipynb b/examples/Step Saving And Lifecycle.ipynb
@@ -15,7 +15,7 @@
    "source": [
     "## Lifecycle\n",
     "\n",
-    "![Machine Learning Lifecycle in Neuraxle](./images/neuraxle_machine_learning_lifecycle.png)"
+    "![Machine Learning Lifecycle in Neuraxle](./_images/neuraxle_machine_learning_lifecycle.png)"
    ]
   },
   {

diff --git a/examples/images/neuraxle_handler_methods.png → ...ples/_images/neuraxle_handler_methods.png b/examples/images/neuraxle_handler_methods.png → ...ples/_images/neuraxle_handler_methods.png
diff --git a/...s/neuraxle_machine_learning_lifecycle.png → ...s/neuraxle_machine_learning_lifecycle.png b/...s/neuraxle_machine_learning_lifecycle.png → ...s/neuraxle_machine_learning_lifecycle.png
diff --git a/examples/_images/neuraxle_time_series_data.png b/examples/_images/neuraxle_time_series_data.png
diff --git a/examples/images/time-series-data.jpg b/examples/images/time-series-data.jpg