diff --git a/docs/index.md b/docs/index.md index 22dd6f4c..9e389406 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,81 +1,267 @@ -
-

- - - -

-
+# Zeta -## 👋 Hello +You can install `zeta` with pip in a +[**Python>=3.10**](https://www.python.org/) environment. -zeta provides you with all the modular lego blocks you need to build bleeding edge AI models as fast as possible. +## Prerequisites +Before you begin, ensure you have the following installed: -## 💻 Install +- Python 3.10 or higher: [Download Python](https://www.python.org/) +- pip (specific version recommended): `pip >= 21.0` +- git (for cloning the repository): [Download Git](https://git-scm.com/) -You can install `zeta` with pip in a -[**Python>=3.8**](https://www.python.org/) environment. +## Installation Options + +=== "pip (Recommended)" + + #### Headless Installation + + The headless installation of `zeta` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications. + + ```bash + pip install zetascale + ``` + +=== "Development Installation" + + === "Using virtualenv" + + 1. **Clone the repository and navigate to the root directory:** + + ```bash + git clone https://github.com/kyegomez/zeta.git + cd zeta + ``` + + 2. **Setup Python environment and activate it:** + + ```bash + python3 -m venv venv + source venv/bin/activate + pip install --upgrade pip + ``` + + 3. **Install zeta:** + + - Headless install: + + ```bash + pip install -e . + ``` + + - Desktop install: + + ```bash + pip install -e .[desktop] + ``` + + === "Using Anaconda" + + 1. **Create and activate an Anaconda environment:** + + ```bash + conda create -n zeta python=3.10 + conda activate zeta + ``` + + 2. **Clone the repository and navigate to the root directory:** + + ```bash + git clone https://github.com/kyegomez/zeta.git + cd zeta + ``` + + 3. **Install zeta:** + + - Headless install: + + ```bash + pip install -e . + ``` + + - Desktop install: -!!! example "pip install (recommended)" + ```bash + pip install -e .[desktop] + ``` - === "headless" - The headless installation of `zeta` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications. + === "Using Poetry" + + 1. **Clone the repository and navigate to the root directory:** + + ```bash + git clone https://github.com/kyegomez/zeta.git + cd zeta + ``` + + 2. **Setup Python environment and activate it:** + + ```bash + poetry env use python3.10 + poetry shell + ``` + + 3. **Install zeta:** + + - Headless install: + + ```bash + poetry install + ``` + + - Desktop install: + + ```bash + poetry install --extras "desktop" + ``` + + \ No newline at end of file