Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[README] added quick start section #53

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,34 @@ Before starting, ensure you have the following:
- Familiarity with Python, PyTorch, and the `transformers` library.
- Access to a pre-trained language model and a labeled dataset.

Here's my suggestion for the improved section, incorporating all your requirements and maintaining consistency:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like an LLM introduction.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lol, sorry, was speedrunning it.


## Quick Start with Dev Containers (Recommended)

The easiest way to get started is using a development container, avoiding any Python version or dependency conflicts. This gives you a ready-to-use environment with everything installed. Think of it as your "smol" setup—sandboxed and efficient!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that we want to make devcontainers the first choice, since it introduces dependencies like: docker desktop, vscode, or alternatives. I'd suggest making devcontainers parallel to uv/pip


### Prerequisites
- Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) (or alternative like [OrbStack](https://orbstack.dev/))

### Option 1: Visual Studio Code
1. Install the "Dev Containers" extension in VS Code
2. Fork this repository and clone it on your computer
3. When you open the repository in VS Code, click "Reopen in Container" in the bottom-right corner pop-up
4. VS Code will automatically set up the environment for you inside a container

### Option 2: Daytona (supports most code editors)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Daytona looks cool and all, but I think we could just reference it, in favour of generalized instructions here.

1. Install [Daytona](https://github.com/daytonaio/daytona/)
2. Run these commands:
```bash
daytona create https://github.com/huggingface/smol-course
daytona code smol-course
```
**Note:** With `daytona ide` command you can select your preferred editor like Cursor, Zed, JetBrains, or Jupyter.

Both options will provide you with an identical, isolated development environment that includes all the necessary tools and dependencies to work through this course.

**Note:** If you prefer to set up your environment manually, see the Installation section below.

## Installation

We maintain the course as a package so you can install dependencies easily via a package manager. We recommend [uv](https://github.com/astral-sh/uv) for this purpose, but you could use alternatives like `pip` or `pdm`.
Expand Down