Skip to content

Commit 977009d

Browse files
committed
Code cleanup
1 parent d9cae23 commit 977009d

File tree

19 files changed

+43
-77
lines changed

19 files changed

+43
-77
lines changed

docs/src/core/how-to/cancel-workflow.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,10 @@ To resume a canceled workflow:
4545
# Reinitialize to reset canceled jobs
4646
torc reinit <workflow_id>
4747

48-
# Run again
49-
torc workflows run <workflow_id>
50-
torc workflows submit <workflow_id>
48+
# Run again locally
49+
torc run <workflow_id>
50+
# Or submit to scheduler
51+
torc submit <workflow_id>
5152
```
5253

5354
Jobs that completed before cancellation remain completed.

docs/src/core/how-to/debug-failed-job.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,10 @@ After fixing the issue:
9292
# Reinitialize to reset failed jobs
9393
torc workflows reset-status --failed --reinitialize <workflow_id>
9494

95-
# Run again
96-
torc workflows run <workflow_id>
97-
torc slurm generate <workflow_id> && torc submit <workflow_id>
95+
# Run again locally
96+
torc run <workflow_id>
97+
# Or re-submit to Slurm
98+
torc submit <workflow_id>
9899
```
99100

100101
## See Also

docs/src/core/reference/cli.md

Lines changed: 6 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -135,24 +135,14 @@ torc slurm generate --account <account> -o workflow_with_schedulers.yaml workflo
135135
torc submit workflow_with_schedulers.yaml
136136
```
137137

138-
**Usage:** `torc submit-slurm [OPTIONS] --account <ACCOUNT> <WORKFLOW_SPEC>`
138+
**Usage:**
139139

140-
###### **Arguments:**
141-
142-
- `<WORKFLOW_SPEC>` — Path to workflow spec file (JSON/JSON5/YAML/KDL)
143-
144-
###### **Options:**
140+
```bash
141+
torc slurm generate [OPTIONS] --account <ACCOUNT> <WORKFLOW_FILE>
142+
torc submit <OUTPUT_FILE>
143+
```
145144

146-
- `--account <ACCOUNT>` — Slurm account to use for allocations
147-
- `--hpc-profile <HPC_PROFILE>` — HPC profile to use (auto-detected if not specified)
148-
- `--single-allocation` — Bundle all nodes into a single Slurm allocation per scheduler. By default,
149-
creates one Slurm allocation per node (N×1 mode), which allows jobs to start as nodes become
150-
available and provides better fault tolerance. With this flag, creates one large allocation with
151-
all nodes (1×N mode), which requires all nodes to be available simultaneously but uses a single
152-
sbatch.
153-
- `-i`, `--ignore-missing-data` — Ignore missing data. Default: `false`
154-
- `--skip-checks` — Skip validation checks (e.g., scheduler node requirements). Use with caution.
155-
Default: `false`
145+
See [`torc slurm generate`](#torc-slurm-generate) for full options.
156146

157147
## `torc watch`
158148

@@ -523,39 +513,6 @@ Archive or unarchive one or more workflows
523513
- `<IS_ARCHIVED>` — Set to true to archive, false to unarchive
524514
- `<WORKFLOW_IDS>` — IDs of workflows to archive/unarchive (if empty, will prompt for selection)
525515

526-
## `torc workflows submit`
527-
528-
Submit a workflow: initialize if needed and schedule nodes for on_workflow_start actions. This
529-
command requires the workflow to have an on_workflow_start action with schedule_nodes.
530-
531-
**Usage:** `torc workflows submit [OPTIONS] [WORKFLOW_ID]`
532-
533-
###### **Arguments:**
534-
535-
- `<WORKFLOW_ID>` — ID of the workflow to submit (optional - will prompt if not provided)
536-
537-
###### **Options:**
538-
539-
- `--force` — If false, fail the operation if missing data is present. Default: `false`
540-
541-
## `torc workflows run`
542-
543-
Run a workflow locally on the current node
544-
545-
**Usage:** `torc workflows run [OPTIONS] [WORKFLOW_ID]`
546-
547-
###### **Arguments:**
548-
549-
- `<WORKFLOW_ID>` — ID of the workflow to run (optional - will prompt if not provided)
550-
551-
###### **Options:**
552-
553-
- `-p`, `--poll-interval <POLL_INTERVAL>` — Poll interval in seconds for checking job completion.
554-
Default: `5.0`
555-
- `--max-parallel-jobs <MAX_PARALLEL_JOBS>` — Maximum number of parallel jobs to run (defaults to
556-
available CPUs)
557-
- `--output-dir <OUTPUT_DIR>` — Output directory for job logs and results. Default: `output`
558-
559516
## `torc init`
560517

561518
Initialize a workflow, including all job statuses

docs/src/core/tutorials/advanced-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ ALL 18 metrics files."
165165
WORKFLOW_ID=$(torc create grid_search.yaml -f json | jq -r '.id')
166166
echo "Created workflow: $WORKFLOW_ID"
167167
168-
torc init-jobs $WORKFLOW_ID
168+
torc init $WORKFLOW_ID
169169
```
170170

171171
## Step 3: Verify the Expansion

docs/src/core/tutorials/diamond.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ echo "Created workflow: $WORKFLOW_ID"
165165
touch /tmp/input.txt
166166
167167
# Initialize the workflow (builds dependency graph)
168-
torc init-jobs $WORKFLOW_ID
168+
torc init $WORKFLOW_ID
169169
```
170170

171171
The `initialize-jobs` command is where Torc:

docs/src/core/tutorials/multi-stage-barrier.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Compare this to **10,000 dependencies** without barriers!
259259
### Step 4: Run the Workflow
260260

261261
```bash
262-
torc workflows run 1
262+
torc run 1
263263
```
264264

265265
### Step 5: Monitor Progress

docs/src/core/tutorials/simple-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ all 5 process jobs.
152152
WORKFLOW_ID=$(torc create learning_rate_sweep.yaml -f json | jq -r '.id')
153153
echo "Created workflow: $WORKFLOW_ID"
154154
155-
torc init-jobs $WORKFLOW_ID
155+
torc init $WORKFLOW_ID
156156
```
157157

158158
## Step 3: Verify the Expansion

docs/src/core/tutorials/user-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ WORKFLOW_ID=$(torc create user_data_workflow.yaml -f json | jq -r '.id')
116116
echo "Created workflow: $WORKFLOW_ID"
117117
118118
# Initialize jobs
119-
torc init-jobs $WORKFLOW_ID
119+
torc init $WORKFLOW_ID
120120
```
121121

122122
## Step 3: Check Initial State

docs/src/core/workflows/creating-workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ torc jobs create \
108108

109109
```bash
110110
# Initialize the workflow (resolves dependencies)
111-
torc init-jobs 1
111+
torc init 1
112112

113113
# Run the workflow
114114
torc run 1

docs/src/core/workflows/export-import-workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,10 @@ file. After import, you need to initialize and run the workflow:
167167
torc init 456
168168

169169
# Run locally
170-
torc workflows run 456
170+
torc run 456
171171

172172
# Or submit to scheduler
173-
torc workflows submit 456
173+
torc submit 456
174174
```
175175

176176
### Default Resource Requirements

0 commit comments

Comments
 (0)