yujunjun/LLMs-from-scratch
1
0
Fork 0
mirror of https://github.com/rasbt/LLMs-from-scratch.git synced 2025-12-04 11:00:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docker files and docs

Browse Source
This commit is contained in:
rasbt 2024-02-29 08:22:53 -06:00
parent 45a10dd823
commit fb770ef97c
3 changed files with 71 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.devcontainer/Dockerfile
View File

@ -2,8 +2,7 @@ FROM pytorch/pytorch:2.2.0-cuda12.1-cudnn8-devel
RUN <<EOF
apt-get update
apt-get install -y --no-install-recommends \
git
apt-get install -y --no-install-recommends git
rm -rf /var/lib/apt/lists/*
EOF

1
.devcontainer/devcontainer.json
View File

@ -9,7 +9,6 @@
"vscode": {
"extensions": [
"ms-python.python",
"ms-python.black-formatter",
"ms-azuretools.vscode-docker",
"ms-toolsai.jupyter",
"esbenp.prettier-vscode"

78
appendix-A/04_optional-docker-environment/README.md
View File

@ -1,22 +1,80 @@
# Docker Environment Setup Guide
The notebooks can be run and developed in a docker container without the need to install any software packages on your local machine. This guide will walk you through that process.
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.
This guide will walk you through the process for setting up an optional docker environment for this book if you prefer it over using the conda approach explained in [../01_optional-python-setup-preferences](../01_optional-python-setup-preferences) and [../02_installing-python-libraries](../02_installing-python-libraries).
## Download and install Docker
<br>
The easiest way to get started with docker is by installing [Docker Desktop](https://docs.docker.com/desktop/) for your relevant platform.
## Downloading and installing Docker
Linux (Ubuntu) users may prefer to install the [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) instead and follow the [post installation](https://docs.docker.com/engine/install/linux-postinstall/) steps.
The easiest way to get started with Docker is by installing [Docker Desktop](https://docs.docker.com/desktop/) for your relevant platform.
Linux (Ubuntu) users may prefer to install the [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) instead and follow the [post-installation](https://docs.docker.com/engine/install/linux-postinstall/) steps.
## Install VSCode
<br>
Whilst devcontainers work with other IDEs as well, I prefer to use Visual Studio Code. [Install](https://code.visualstudio.com/download) it if you don't have it and want to use it. The instructions below will be VSCode specific but a similar process should apply to PyCharm as well.
## Using a Docker DevContainer in Visual Studio Code
A Docker DevContainer, or Development Container, is a tool that allows developers to use Docker containers as a fully-fledged development environment. This approach ensures that users can quickly get up and running with a consistent development environment, regardless of their local machine setup.
While DevContainers also work with other IDEs, a commonly used IDE/editor for working with DevContainers is Visual Studio Code (VS Code). The guide below explains how to use the DevContainer for this book within a VS Code context, but a similar process should also apply to PyCharm. [Install](https://code.visualstudio.com/download) it if you don't have it and want to use it.
1. Clone this GitHub repository and `cd` into the project root directory.
```bash
git clone https://github.com/rasbt/LLMs-from-scratch.git
cd LLMs-from-scratch
```
1. Clone and `cd` into the project root directory.
2. Type `code .` in the terminal to open the project in VS Code. Alternatively, you can launch VS Code and select the project to open from the UI.
3. Install the **Remote Development** extension from the Extensions tab.
4. Since the `.devcontainer` folder is present, VSCode should automatically detect it and ask whether you would like to open the project in a devcontainer. If it doesn't, simply press `Ctrl + Shift + P` to open the command palette and start typing `dev containers` to see a list of all Dev Container specific options.
3. Install the **Remote Development** extension from the VS Code *Extensions* menu on the left-hand side.
4. Open the DevContainer.
Since the `.devcontainer` folder is present in the main `LLMs-from-scratch` directory (folders starting with `.` may be invisible in your OS depending on your settings), VS Code should automatically detect it and ask whether you would like to open the project in a devcontainer. If it doesn't, simply press `Ctrl + Shift + P` to open the command palette and start typing `dev containers` to see a list of all DevContainer-specific options.
5. Select **Reopen in Container**.
6. Once the image has been pulled and built, you should have your project mounted inside the container with all the packages installed, ready for development.
Docker will now begin the process of building the Docker image specified in the `.devcontainer` configuration if it hasn't been built before, or pull the image if it's available from a registry.
The entire process is automated and might take a few minutes, depending on your system and internet speed. Optionally clock on "Starting Dev Container (show log)" in the lower right corner of VS Code to see the current built progress.
Once completed, VS Code will automatically connect to the container and reopen the project within the newly created Docker development environment. You will be able to write, execute, and debug code as if it were running on your local machine, but with the added benefits of Docker's isolation and consistency.
> [!WARNING]
> If you are encountering an error during the build process, this is likely because your machine does not support NVIDIA container toolkit because your machine doesn't have a compatible GPU. In this case, edit the `devcontainer.json` file to remove the `"runArgs": ["--runtime=nvidia", "--gpus=all"],` line and run the "Reopen Dev Container" procedure again.
6. Finished.
Once the image has been pulled and built, you should have your project mounted inside the container with all the packages installed, ready for development.
<br>
## Uninstalling the Docker Image
Below are instructions for uninstalling or removing a Docker container and image if you no longer plan to use it. This process does not remove Docker itself from your system but rather cleans up the project-specific Docker artifacts.
1. List all Docker images to find the one associated with your DevContainer:
```bash
docker image ls
```
2. Remove the Docker image using its image ID or name:
```bash
docker image rm [IMAGE_ID_OR_NAME]
```
<br>
## Uninstalling Docker
If you decide that Docker is not for you and wish to uninstall it, see the official documentation [here](https://docs.docker.com/desktop/uninstall/) that outlines the steps for your specific operating system.