Skip to content

Commit 1908676

Browse files
committed
add setup recommendations
1 parent 4286f69 commit 1908676

File tree

4 files changed

+57
-0
lines changed

4 files changed

+57
-0
lines changed

.1st_setup/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Optional Setup Instructions
2+
3+
4+
This document lists different approaches for setting up your machine and using the code in this repository. I recommend browsing through the different sections from top to bottom and then deciding which approach best suits your needs.
5+
6+
<br>
7+
8+
## Quickstart
9+
10+
If you already have a Python installation on your machine, the quickest way to get started is to install the package requirements from the [../requirements.txt](../requirements.txt) file by executing the following pip installation command from the root directory of this code repository:
11+
12+
```bash
13+
pip install -r requirements.txt
14+
```
15+
16+
<br>
17+
18+
## Setting up Python
19+
20+
If you don't have Python set up on your machine yet, I have written about my personal Python setup preferences in the following directories:
21+
22+
- [../appendix-A/01_optional-python-setup-preferences](../appendix-A/01_optional-python-setup-preferences)
23+
- [../02_installing-python-libraries](../appendix-A/02_installing-python-libraries)
24+
25+
26+
27+
28+
<br>
29+
30+
## Using Google Colab
31+
32+
To use a Google Colab environment in the cloud, head over to [https://colab.research.google.com/](https://colab.research.google.com/) and open the respective chapter notebook from the GitHub menu or by dragging the notebook into the *Upload* field as shown in the figure below.
33+
34+
<img src="./figures/1.webp" alt="1" width="700">
35+
36+
37+
Also make sure you upload the relevant files (dataset files and .py files the notebook is importing from) to the Colab environment as well, as shown below.
38+
39+
<img src="./figures/2.webp" alt="2" width="700">
40+
41+
42+
You can optionally run the code on a GPU by changing the *Runtime* as illustrated in the figure below.
43+
44+
<img src="./figures/3.webp" alt="3" width="700">
45+
46+
47+
<br>
48+
49+
## Using DevContainers
50+
51+
Alternatively, If you prefer a development setup that isolates a project's dependencies and configurations, using Docker is a highly effective solution. This approach eliminates the need to manually install software packages and libraries and ensures a consistent development environment. You can find more instructions for setting up Docker and using a DevContainer here in [../appendix-A/04_optional-docker-environment](../appendix-A/04_optional-docker-environment).
52+
53+
<br>
54+
55+
## Questions?
56+
57+
If you have any questions, please don't hesitate to reach out via the [Discussions](https://github.com/rasbt/LLMs-from-scratch/discussions) forum in this GitHub repository.

.1st_setup/figures/1.webp

35.3 KB
Binary file not shown.

.1st_setup/figures/2.webp

62 KB
Binary file not shown.

.1st_setup/figures/3.webp

30.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)