Update docs

sb-ai-lab · Jul 1, 2022 · 6bf3bd4 · 6bf3bd4
1 parent ad97dcc
commit 6bf3bd4
Show file tree

Hide file tree

Showing 64 changed files with 114 additions and 6,807 deletions.
diff --git a/.gitignore b/.gitignore
@@ -165,5 +165,5 @@ dumps
 *.orig
 
 docs/generated
-docs/slama-docs/generated
+docs/pages/modules/generated
 rsync-repo.sh
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,6 +5,20 @@
 # Required
 version: 2
 
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add poetry
+      - asdf install poetry latest
+      - asdf global poetry latest
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install --E all
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
@@ -14,7 +28,7 @@ formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.6
   install:
     - requirements: docs/requirements.txt
+    - path: .
   system_packages: true
diff --git a/docs/Tutorials.rst b/docs/Tutorials.rst
diff --git a/docs/addons.rst b/docs/addons.rst
diff --git a/docs/automl.rst b/docs/automl.rst
diff --git a/docs/dataset.rst b/docs/dataset.rst
diff --git a/docs/image.rst b/docs/image.rst
diff --git a/...lama-docs/imgs/LightAutoML_repo_files.png → docs/imgs/LightAutoML_repo_files.png b/...lama-docs/imgs/LightAutoML_repo_files.png → docs/imgs/LightAutoML_repo_files.png
diff --git a/docs/slama-docs/imgs/docker_compose_ps.png → docs/imgs/docker_compose_ps.png b/docs/slama-docs/imgs/docker_compose_ps.png → docs/imgs/docker_compose_ps.png
diff --git a/...lama-docs/imgs/docker_compose_setting.png → docs/imgs/docker_compose_setting.png b/...lama-docs/imgs/docker_compose_setting.png → docs/imgs/docker_compose_setting.png
diff --git a/...ama-docs/imgs/hadoop_application_logs.png → docs/imgs/hadoop_application_logs.png b/...ama-docs/imgs/hadoop_application_logs.png → docs/imgs/hadoop_application_logs.png
diff --git a/...-docs/imgs/hadoop_applications_web_ui.png → docs/imgs/hadoop_applications_web_ui.png b/...-docs/imgs/hadoop_applications_web_ui.png → docs/imgs/hadoop_applications_web_ui.png
diff --git a/docs/slama-docs/imgs/hadoop_settings.png → docs/imgs/hadoop_settings.png b/docs/slama-docs/imgs/hadoop_settings.png → docs/imgs/hadoop_settings.png
diff --git a/...ma-docs/imgs/hadoop_view_application1.png → docs/imgs/hadoop_view_application1.png b/...ma-docs/imgs/hadoop_view_application1.png → docs/imgs/hadoop_view_application1.png
diff --git a/...ma-docs/imgs/hadoop_view_application2.png → docs/imgs/hadoop_view_application2.png b/...ma-docs/imgs/hadoop_view_application2.png → docs/imgs/hadoop_view_application2.png
diff --git a/docs/slama-docs/imgs/hdfs_web_ui.png → docs/imgs/hdfs_web_ui.png b/docs/slama-docs/imgs/hdfs_web_ui.png → docs/imgs/hdfs_web_ui.png
diff --git a/docs/slama-docs/imgs/image2.png → docs/imgs/image2.png b/docs/slama-docs/imgs/image2.png → docs/imgs/image2.png
diff --git a/docs/slama-docs/imgs/image3.png → docs/imgs/image3.png b/docs/slama-docs/imgs/image3.png → docs/imgs/image3.png
diff --git a/docs/slama-docs/imgs/image4.png → docs/imgs/image4.png b/docs/slama-docs/imgs/image4.png → docs/imgs/image4.png
diff --git a/docs/slama-docs/imgs/image6.png → docs/imgs/image6.png b/docs/slama-docs/imgs/image6.png → docs/imgs/image6.png
diff --git a/docs/slama-docs/imgs/image7.png → docs/imgs/image7.png b/docs/slama-docs/imgs/image7.png → docs/imgs/image7.png
diff --git a/.../slama-docs/imgs/link_to_spark_web_ui.png → docs/imgs/link_to_spark_web_ui.png b/.../slama-docs/imgs/link_to_spark_web_ui.png → docs/imgs/link_to_spark_web_ui.png
diff --git a/docs/slama-docs/imgs/minikube_image2.png → docs/imgs/minikube_image2.png b/docs/slama-docs/imgs/minikube_image2.png → docs/imgs/minikube_image2.png
diff --git a/docs/slama-docs/imgs/spark_web_ui.png → docs/imgs/spark_web_ui.png b/docs/slama-docs/imgs/spark_web_ui.png → docs/imgs/spark_web_ui.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,49 +1,29 @@
-LightAutoML documentation
-=========================
+SLAMA (Spark version of LAMA)
+=============================
 
-`LightAutoML <https://github.com/fonhorst/LightAutoML_Spark>`_ is open-source Python library aimed at automated machine learning.
-It is designed to be lightweight and efficient for various tasks with tabular, text data.
-LightAutoML provides easy-to-use pipeline creation, that enables:
+This is a distributed version of `LAMA <https://github.com/sb-ai-lab/LightAutoML` library written on Spark framework.
+SLAMA brings LAMA functionality on Spark including:
 
 - Automatic hyperparameter tuning, data processing.
 - Automatic typing, feature selection.
 - Automatic time utilization.
 - Automatic report creation.
-- Graphical profiling system.
 - Easy-to-use modular scheme to create your own pipelines.
+- Support of Spark ML pipelines, including saving/loading.
+- Caching and checkpointing of intermediate results
 
+Known limitations:
+- Only the tabular preset is currently supported
 
 
-.. toctree::
-    :maxdepth: 1
-    :caption: Python API
-
-    automl
-    addons
-    dataset
-    image
-    ml_algo
-    ml_algo.tuning
-    pipelines
-    pipelines.selection
-    pipelines.features
-    pipelines.ml
-    reader
-    report
-    tasks
-    tasks.losses
-    text
-    transformers
-    utils
-    validation
-
 
-SLAMA (Spark version of LAMA)
-==================
 .. toctree::
     :maxdepth: 1
+    :caption: Contents:
+
+    Deployment <pages/Deployment.rst>
+    Python-API <pages/Python-API>
 
-    slama-docs/slama_index
 
 Indices and Tables
 ==================

diff --git a/docs/ml_algo.rst b/docs/ml_algo.rst
diff --git a/docs/ml_algo.tuning.rst b/docs/ml_algo.tuning.rst