From d579a5ef9a5c60a631d87e183b981a9b10431a29 Mon Sep 17 00:00:00 2001 From: Jiaxin Shan Date: Thu, 12 Sep 2024 15:04:53 -0700 Subject: [PATCH] Add template page for the docs (#170) * Add template page for the docs * Fix a typo in the requirements-docs.txt --- docs/requirements-docs.txt | 2 +- .../logos/aibrix-logo-light.png} | Bin docs/source/community/community.rst | 7 ++ docs/source/conf.py | 6 +- docs/source/designs/architecture.rst | 7 ++ docs/source/development/contribution.rst | 7 ++ docs/source/features/autoscaling.rst | 7 ++ docs/source/features/gateway-plugins.rst | 7 ++ docs/source/features/lora-dynamic-loading.rst | 7 ++ docs/source/features/multi-node-inference.rst | 7 ++ docs/source/features/runtime.rst | 7 ++ docs/source/getstarted/quickstart.rst | 6 -- docs/source/getting_started/installation.rst | 7 ++ docs/source/getting_started/quickstart.rst | 7 ++ docs/source/index.rst | 68 +++++++++--------- docs/source/serving/installation.rst | 6 -- 16 files changed, 108 insertions(+), 50 deletions(-) rename docs/source/{aibrix_icon.png => assets/logos/aibrix-logo-light.png} (100%) create mode 100644 docs/source/community/community.rst create mode 100644 docs/source/designs/architecture.rst create mode 100644 docs/source/development/contribution.rst create mode 100644 docs/source/features/autoscaling.rst create mode 100644 docs/source/features/gateway-plugins.rst create mode 100644 docs/source/features/lora-dynamic-loading.rst create mode 100644 docs/source/features/multi-node-inference.rst create mode 100644 docs/source/features/runtime.rst delete mode 100644 docs/source/getstarted/quickstart.rst create mode 100644 docs/source/getting_started/installation.rst create mode 100644 docs/source/getting_started/quickstart.rst delete mode 100644 docs/source/serving/installation.rst diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 15581107..e6a7bed3 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -4,5 +4,5 @@ sphinx-click==6.0.0 sphinx-copybutton==0.5.2 sphinx-togglebutton==0.3.2 sphinxemoji==0.3.1 -sphinx-autodoc-typehints-2.4.1==2.4.1 +sphinx-autodoc-typehints==2.4.1 sphinx_design==0.6.1 diff --git a/docs/source/aibrix_icon.png b/docs/source/assets/logos/aibrix-logo-light.png similarity index 100% rename from docs/source/aibrix_icon.png rename to docs/source/assets/logos/aibrix-logo-light.png diff --git a/docs/source/community/community.rst b/docs/source/community/community.rst new file mode 100644 index 00000000..1765a557 --- /dev/null +++ b/docs/source/community/community.rst @@ -0,0 +1,7 @@ +.. _community: + +========= +Community +========= + +TODO diff --git a/docs/source/conf.py b/docs/source/conf.py index 97dc7e18..bf9afe67 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,7 @@ html_title = project html_theme = 'sphinx_book_theme' -html_logo = 'aibrix_icon.png' +html_logo = 'assets/logos/aibrix-logo-light.png' html_static_path = ['_static'] html_theme_options = { # repository level setting @@ -57,8 +57,8 @@ # navigation and sidebar - 'show_toc_level': 1, - 'announcement': 'This is still in private mode', + 'show_toc_level': 2, + 'announcement': None, 'secondary_sidebar_items': [ 'page-toc', ], diff --git a/docs/source/designs/architecture.rst b/docs/source/designs/architecture.rst new file mode 100644 index 00000000..0d8132ee --- /dev/null +++ b/docs/source/designs/architecture.rst @@ -0,0 +1,7 @@ +.. _architecture: + +==================== +Overall Architecture +==================== + +TODO diff --git a/docs/source/development/contribution.rst b/docs/source/development/contribution.rst new file mode 100644 index 00000000..3e671000 --- /dev/null +++ b/docs/source/development/contribution.rst @@ -0,0 +1,7 @@ +.. _contribution: + +============ +Contribution +============ + +TODO diff --git a/docs/source/features/autoscaling.rst b/docs/source/features/autoscaling.rst new file mode 100644 index 00000000..51e88999 --- /dev/null +++ b/docs/source/features/autoscaling.rst @@ -0,0 +1,7 @@ +.. _autoscaling: + +=========== +Autoscaling +=========== + +TODO diff --git a/docs/source/features/gateway-plugins.rst b/docs/source/features/gateway-plugins.rst new file mode 100644 index 00000000..9d9e2b6d --- /dev/null +++ b/docs/source/features/gateway-plugins.rst @@ -0,0 +1,7 @@ +.. _gateway: + +=============== +Gateway Routing +=============== + +TODO \ No newline at end of file diff --git a/docs/source/features/lora-dynamic-loading.rst b/docs/source/features/lora-dynamic-loading.rst new file mode 100644 index 00000000..94e62426 --- /dev/null +++ b/docs/source/features/lora-dynamic-loading.rst @@ -0,0 +1,7 @@ +.. _lora: + +==================== +Lora Dynamic Loading +==================== + +TODO \ No newline at end of file diff --git a/docs/source/features/multi-node-inference.rst b/docs/source/features/multi-node-inference.rst new file mode 100644 index 00000000..d60500d0 --- /dev/null +++ b/docs/source/features/multi-node-inference.rst @@ -0,0 +1,7 @@ +.. _distributed_inference: + +==================== +Multi-Node Inference +==================== + +TODO \ No newline at end of file diff --git a/docs/source/features/runtime.rst b/docs/source/features/runtime.rst new file mode 100644 index 00000000..234a1bf8 --- /dev/null +++ b/docs/source/features/runtime.rst @@ -0,0 +1,7 @@ +.. _ai_runtime: + +========== +AI Runtime +========== + +TODO \ No newline at end of file diff --git a/docs/source/getstarted/quickstart.rst b/docs/source/getstarted/quickstart.rst deleted file mode 100644 index 6ae43bee..00000000 --- a/docs/source/getstarted/quickstart.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _quickstart_section: - -Quickstart Section -================== - -This section contains how to do a quickstart. diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst new file mode 100644 index 00000000..79f536e3 --- /dev/null +++ b/docs/source/getting_started/installation.rst @@ -0,0 +1,7 @@ +.. _installation: + +============ +Installation +============ + +This section contains how to install the packages. diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst new file mode 100644 index 00000000..f0ca2346 --- /dev/null +++ b/docs/source/getting_started/quickstart.rst @@ -0,0 +1,7 @@ +.. _quickstart: + +========== +Quickstart +========== + +This section contains how to do a quickstart. diff --git a/docs/source/index.rst b/docs/source/index.rst index d0e6e1c5..5a578617 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,57 +1,57 @@ -.. AIBrix documentation master file, created by - sphinx-quickstart on Thu Aug 8 15:07:35 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to AIBrix ================= -.. image:: aibrix_icon.png - :width: 400 - :alt: Alternative text - -AIBrix is a high-performant and easy-to-use library for LLM inference. - -AIBrix is high-performant at +.. image:: ./assets/logos/aibrix-logo-light.png + :width: 60% + :align: center + :alt: AIBrix -* This is a bulleted list. -* It has two items, the second - item uses two lines. +AIBrix is the foundational building blocks for constructing your own GenAI inference infrastructure. +AIBrix offers a cloud-native solution tailored to meet the demands of enterprises aiming to deploy, manage, and scale LLMs efficiently. +Key features: -AIBrix is easy-to-use with +* High density Lora management +* Intelligent and LLM specific routing strategies +* LLM tailored pod autoscaler +* AI runtime sidecar (metrics merge, fast model downloading, admin operations) -1. This is a numbered list. -2. It has two items too. -#. This is a numbered list. -#. It has two items too. Documentation ============= -Get Started ------------ - .. toctree:: - :caption: Chapter 1 - :titlesonly: - - - getstarted/quickstart - + :maxdepth: 1 + :caption: Getting Started + getting_started/quickstart.rst + getting_started/installation.rst .. toctree:: - :caption: Chapter 2 - :titlesonly: + :maxdepth: 1 + :caption: Core Concepts - serving/installation - External Link + designs/architecture.rst +.. toctree:: + :maxdepth: 1 + :caption: User Manuals + features/autoscaling.rst + features/lora-dynamic-loading.rst + features/gateway-plugins.rst + features/multi-node-inference.rst + features/runtime.rst +.. toctree:: + :maxdepth: 1 + :caption: Development + development/contribution.rst +.. toctree:: + :maxdepth: 1 + :caption: Community -This is an example of a simple Sphinx project using the Sphinx Book Theme. + community/community.rst diff --git a/docs/source/serving/installation.rst b/docs/source/serving/installation.rst deleted file mode 100644 index cdb869b1..00000000 --- a/docs/source/serving/installation.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _installation_section: - -Installation Section -==================== - -This section contains detailed information.