small improvements to installation section

swapUniba · Aug 5, 2024 · efe3fdd · efe3fdd
1 parent 41283ad
commit efe3fdd
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -90,6 +90,12 @@ of developing *accountable* experiment pipelines
 
 ## Installation
 
+### Via Docker Image
+
+Simply pull the latest [LaikaLLM Docker Image](https://hub.docker.com/r/silleellie/laikallm) 
+which includes every preliminary step to run the project, including setting `PYTHONHASHSEED` and
+`CUBLAS_WORKSPACE_CONFIG` for reproducibility purposes
+
 ### From source
 
 *LaikaLLM* requires **Python 3.10** or later, and all packages needed are listed in 
@@ -100,9 +106,10 @@ of developing *accountable* experiment pipelines
 
 To install **LaikaLLM**:
 
-1. Clone this repository:
+1. Clone this repository and change work directory:
   ```
   git clone https://github.com/Silleellie/LaikaLLM.git
+  cd LaikaLLM
   ```
 2. Install the requirements:
   ```
@@ -121,11 +128,6 @@ export CUBLAS_WORKSPACE_CONFIG=:16:8
 
 You can check useful info about the above environment variables [here](https://docs.python.org/3.3/using/cmdline.html#envvar-PYTHONHASHSEED) and [here](https://docs.nvidia.com/cuda/cublas/index.html#results-reproducibility)
 
-### Via Docker Image
-
-Simply pull the latest [LaikaLLM Docker Image](https://hub.docker.com/r/silleellie/laikallm) 
-which includes every preliminary step to run the project, including setting `PYTHONHASHSEED` and
-`CUBLAS_WORKSPACE_CONFIG` for reproducibility purposes
 
 ## Usage
 

diff --git a/mkdocs/docs/quickstart/installation.md b/mkdocs/docs/quickstart/installation.md
@@ -1,6 +1,12 @@
 # Installation
 
-## From source <small>recommended</small> { data-toc-label="From source" }
+## Via Docker Image <small>recommended</small> { data-toc-label="Via Docker Image" }
+
+Simply pull the latest [LaikaLLM Docker Image](https://hub.docker.com/r/silleellie/laikallm) 
+which includes every preliminary step to run the project, including setting `PYTHONHASHSEED` and
+`CUBLAS_WORKSPACE_CONFIG` for reproducibility purposes!
+
+## From source
 
 *LaikaLLM* requires **Python 3.10** or later, and all packages needed are listed in 
 [`requirements.txt`](https://github.com/Silleellie/LaikaLLM/blob/main/requirements.txt)
@@ -10,9 +16,10 @@
 
 To install **LaikaLLM**:
 
-1. Clone this repository:
+1. Clone this repository and change work directory:
   ```
   git clone https://github.com/Silleellie/LaikaLLM.git
+  cd LaikaLLM
   ```
 2. Install the requirements:
   ```
@@ -39,7 +46,7 @@ You can check useful info about the above environment variables [here](https://d
 
 
 ---
-**Tip**: It is suggested to install LaikaLLM requirements in a virtual environment
+**Tip**: In case of installation from source, it is suggested to install LaikaLLM requirements in a virtual environment
 
 !!! quote ""
     *Virtual environments are special isolated environments where all the packages and versions you install only 
@@ -50,11 +57,3 @@ on how to set up one
 
 [medium]: https://towardsdatascience.com/why-you-should-use-a-virtual-environment-for-every-python-project-c17dab3b0fd0
 [venv]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/
-
----
-
-## Via Docker Image
-
-Simply pull the latest [LaikaLLM Docker Image](https://hub.docker.com/r/silleellie/laikallm) 
-which includes every preliminary step to run the project, including setting `PYTHONHASHSEED` and
-`CUBLAS_WORKSPACE_CONFIG` for reproducibility purposes!