Skip to content

Commit 21e20fa

Browse files
committed
Update README
1 parent 81ba651 commit 21e20fa

File tree

1 file changed

+16
-38
lines changed

1 file changed

+16
-38
lines changed

README.md

Lines changed: 16 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,29 @@
1-
# Labspace starter
1+
# Labspace - Fine tuning
22

3-
This repository is intended to server as a template to help bootstrap a new Labspace.
3+
This Labspace provides a hands-on walkthrough on fine-tuning models using Docker Offload, Docker Model Runner, and Unsloth.
44

5-
## Instructions
5+
## Learning objectives
66

7-
1. Create a new repository using this repo as the template ([docs here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)).
7+
This Labspace will teach you the following:
88

9-
**NOTE:** After creating the repo, a GHA workflow will run to do some additional bootstrapping. The bootstrapping workflow file will be removed during bootstrapping.
9+
- Use Docker Offload to fine tune a model
10+
- Package and share the model on Docker Hub
11+
- Run the custom model with Docker Model Runner
1012

11-
2. Clone your newly created repo to your local machine
13+
## Launch the Labspace
1214

13-
3. Start the local development mode:
15+
To launch the Labspace, run the following command:
1416

15-
```bash
16-
# On Mac/Linux
17-
CONTENT_PATH=$PWD docker compose -f oci://dockersamples/labspace-content-dev -f .labspace/compose.override.yaml up
18-
19-
# On Windows with PowerShell
20-
$Env:CONTENT_PATH = (Get-Location).Path; docker compose -f oci://dockersamples/labspace-content-dev -f .labspace/compose.override.yaml up
21-
```
22-
23-
4. Update the `labspace.yaml` with your Labspace's title and description
24-
25-
5. Write your Labspace! Being in dev mode, your changes should be visible in the interface without a restart. Feel free to edit either on your host machine or in the Labspace itself!
26-
27-
Add any supporting application files or resources directly into the Labspace. This repo will be cloned into the Labspace at startup.
28-
29-
Be sure to check out the [docs](https://github.com/dockersamples/labspace-infra/tree/main/docs) for additional information and guidelines.
30-
31-
32-
33-
### Setting up the deployment pipeline
34-
35-
The template repo contains a workflow file to make it easy to publish your Labspace.
36-
37-
1. Add GitHub Action Secrets in your new repo for the following:
17+
```bash
18+
docker compose -f oci://dockersamples/labspace-fine-tuning up -d
19+
```
3820

39-
- `DOCKERHUB_USERNAME` - the username to authenticate to Docker Hub with
40-
- `DOCKERHUB_TOKEN` - a personal or organization access token to use for authentication
21+
And then open your browser to http://localhost:3030.
4122

42-
2. In the `.github/workflows/publish-labspace.yaml.temp` file, update the `DOCKERHUB_REPO` with the name of the Docker Hub repo you want to publish to.
23+
### Using the Docker Desktop extension
4324

44-
3. Rename the workflow file to remove the `.temp` extension.
25+
If you have the Labspace extension installed (`docker extension install dockersamples/labspace-extension` if not), you can also click [this link](https://open.docker.com/dashboard/extension-tab?extensionId=dockersamples/labspace-extension&location=dockersamples/labspace-fine-tuning&title=Fine-tuning%20local%20models) to launch the Labspace.
4526

46-
```bash
47-
mv .github/workflows/publish-labspace.yaml.temp .github/workflows/publish-labspace.yaml
48-
```
4927

5028
## Acknowledgements
5129

@@ -55,7 +33,7 @@ Special thanks to AI4Privacy for providing the comprehensive PII masking dataset
5533

5634
### Dataset Source
5735

58-
The training dataset `pii_redaction_train.json` used in this example was created from the **AI4Privacy PII Masking 400k Dataset**:
36+
The training dataset `data/training_data.json` used in this example was created from the **AI4Privacy PII Masking 400k Dataset**:
5937

6038
- **Original Dataset**: [ai4privacy/pii-masking-400k](https://huggingface.co/datasets/ai4privacy/pii-masking-400k)
6139
- **Dataset Description**: World's largest open dataset for privacy masking with 406,896 entries

0 commit comments

Comments
 (0)