davanstrien HF Staff commited on
Commit
e4dd652
ยท
1 Parent(s): 50a87a3

Add HF Jobs getting started guide and update documentation links

Browse files

- Add first-time setup instructions for HF Jobs
- Include CLI installation and login steps
- Update HF Jobs documentation link to correct URL
- Add HF CLI guide link to resources
- Keep --secrets flag in all command examples

Files changed (1) hide show
  1. README.md +29 -1
README.md CHANGED
@@ -14,6 +14,33 @@ Generate synthetic datasets using OpenAI's GPT OSS models with transparent reaso
14
 
15
  Successfully tested on HF Jobs with `l4x4` flavor (4x L4 GPUs = 96GB total memory).
16
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  ## ๐ŸŒŸ Quick Start
18
 
19
  ```bash
@@ -128,7 +155,8 @@ OpenAI recommends `temperature=1.0` and `top_p=1.0` as defaults for GPT OSS mode
128
 
129
  - [OpenAI GPT OSS Model Collection](https://huggingface.co/collections/openai/gpt-oss-68911959590a1634ba11c7a4) - Both 20B and 120B models
130
  - [Model: openai/gpt-oss-20b](https://huggingface.co/openai/gpt-oss-20b)
131
- - [HF Jobs Documentation](https://huggingface.co/docs/hub/spaces-gpu-jobs)
 
132
  - [Dataset: davanstrien/haiku_dpo](https://huggingface.co/datasets/davanstrien/haiku_dpo)
133
 
134
  ---
 
14
 
15
  Successfully tested on HF Jobs with `l4x4` flavor (4x L4 GPUs = 96GB total memory).
16
 
17
+ ## ๐Ÿš€ Getting Started with HF Jobs
18
+
19
+ ### First-time Setup (2 minutes)
20
+
21
+ 1. **Install HuggingFace CLI**:
22
+ ```bash
23
+ pip install huggingface-hub
24
+ ```
25
+
26
+ 2. **Login to HuggingFace**:
27
+ ```bash
28
+ huggingface-cli login
29
+ ```
30
+ (Enter your HF token when prompted - get one at https://huggingface.co/settings/tokens)
31
+
32
+ 3. **Run the script on HF Jobs**:
33
+ ```bash
34
+ hf jobs uv run --flavor l4x4 --secrets HF_TOKEN=hf_*** \
35
+ https://huggingface.co/datasets/uv-scripts/openai-oss/raw/main/gpt_oss_minimal.py \
36
+ --input-dataset davanstrien/haiku_dpo \
37
+ --output-dataset YOUR_USERNAME/gpt-oss-test \
38
+ --prompt-column question \
39
+ --max-samples 2
40
+ ```
41
+
42
+ That's it! Your job will run on HuggingFace's GPUs and the output dataset will appear in your HF account.
43
+
44
  ## ๐ŸŒŸ Quick Start
45
 
46
  ```bash
 
155
 
156
  - [OpenAI GPT OSS Model Collection](https://huggingface.co/collections/openai/gpt-oss-68911959590a1634ba11c7a4) - Both 20B and 120B models
157
  - [Model: openai/gpt-oss-20b](https://huggingface.co/openai/gpt-oss-20b)
158
+ - [HF Jobs Documentation](https://huggingface.co/docs/huggingface_hub/guides/jobs) - Complete guide to running jobs on HuggingFace
159
+ - [HF CLI Guide](https://huggingface.co/docs/huggingface_hub/guides/cli) - HuggingFace CLI installation and usage
160
  - [Dataset: davanstrien/haiku_dpo](https://huggingface.co/datasets/davanstrien/haiku_dpo)
161
 
162
  ---