davanstrien HF Staff commited on
Commit
8d2a085
·
1 Parent(s): ba42011

Update README with accurate HF Jobs instructions and complete options

Browse files
Files changed (1) hide show
  1. README.md +8 -2
README.md CHANGED
@@ -52,8 +52,12 @@ uv run atlas-export.py \
52
  ### GPU Acceleration (HF Jobs)
53
 
54
  ```bash
 
 
 
55
  # Run on HF Jobs with GPU using experimental UV support
56
  hf jobs uv run --flavor t4-small \
 
57
  https://huggingface.co/datasets/uv-scripts/build-atlas/raw/main/atlas-export.py \
58
  stanfordnlp/imdb \
59
  --space-name imdb-viz \
@@ -61,7 +65,7 @@ hf jobs uv run --flavor t4-small \
61
  --sample 10000
62
  ```
63
 
64
- Note: HF Jobs will automatically use your HF token for authentication.
65
 
66
  ## Key Options
67
 
@@ -70,11 +74,13 @@ Note: HF Jobs will automatically use your HF token for authentication.
70
  | `dataset_id` | HuggingFace dataset to visualize | Required |
71
  | `--space-name` | Name for your Space | Required |
72
  | `--model` | Embedding model to use | Auto-selected |
73
- | `--text-column` | Column containing text | Auto-detected |
74
  | `--image-column` | Column containing images | None |
75
  | `--sample` | Number of samples to visualize | All |
 
76
  | `--local-only` | Generate locally without deploying | False |
77
  | `--output-dir` | Local output directory | Temp dir |
 
78
 
79
  Run without arguments to see all options and more examples.
80
 
 
52
  ### GPU Acceleration (HF Jobs)
53
 
54
  ```bash
55
+ # First, get your HF token (if not already set)
56
+ python -c "from huggingface_hub import get_token; print(get_token())"
57
+
58
  # Run on HF Jobs with GPU using experimental UV support
59
  hf jobs uv run --flavor t4-small \
60
+ -s HF_TOKEN=your-token-here \
61
  https://huggingface.co/datasets/uv-scripts/build-atlas/raw/main/atlas-export.py \
62
  stanfordnlp/imdb \
63
  --space-name imdb-viz \
 
65
  --sample 10000
66
  ```
67
 
68
+ Note: Replace `your-token-here` with your actual token. Available GPU flavors: `t4-small`, `t4-medium`, `l4x1`, `a10g-small`.
69
 
70
  ## Key Options
71
 
 
74
  | `dataset_id` | HuggingFace dataset to visualize | Required |
75
  | `--space-name` | Name for your Space | Required |
76
  | `--model` | Embedding model to use | Auto-selected |
77
+ | `--text-column` | Column containing text | "text" |
78
  | `--image-column` | Column containing images | None |
79
  | `--sample` | Number of samples to visualize | All |
80
+ | `--split` | Dataset split to use | "train" |
81
  | `--local-only` | Generate locally without deploying | False |
82
  | `--output-dir` | Local output directory | Temp dir |
83
+ | `--hf-token` | HuggingFace API token | From env/CLI |
84
 
85
  Run without arguments to see all options and more examples.
86