Skip to content

Commit a8fb74c

Browse files
committed
remove nvdecs in docs
Signed-off-by: Ao Tang <aot@nvidia.com>
1 parent 0c5947d commit a8fb74c

File tree

7 files changed

+5
-17
lines changed

7 files changed

+5
-17
lines changed

.github/copilot-instructions.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,6 @@ class Resources:
361361
cpus: float = 1.0 # Number of CPU cores
362362
gpu_memory_gb: float = 0.0 # Number of GPU memory in GB (Only for single GPU)
363363
gpus: float = 0.0 # Number of GPUs (Only for multi-GPU)
364-
nvdecs: int = 0 # Number of NVDEC decoders
365-
nvencs: int = 0 # Number of NVENC encoders
366364
entire_gpu: bool = False # Whether to use the entire GPU
367365
```
368366

api-design.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,6 @@ class Resources:
132132
cpus: float = 1.0 # Number of CPU cores
133133
gpu_memory_gb: float = 0.0 # Number of GPU memory in GB (Only for single GPU)
134134
gpus: float = 0.0 # Number of GPUs (Only for multi-GPU)
135-
nvdecs: int = 0 # Number of NVDEC decoders
136-
nvencs: int = 0 # Number of NVENC encoders
137135
entire_gpu: bool = False # Whether to use the entire GPU
138136
```
139137

docs/about/concepts/video/abstractions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ A stage represents a single step in your data curation workflow. Video stages ar
4848
Each processing stage:
4949

5050
1. Inherits from `ProcessingStage`
51-
2. Declares a stable `name` and `resources: Resources` (CPU cores, GPU memory, optional NVDEC/NVENC, or more than one GPU)
51+
2. Declares a stable `name` and `resources: Resources` (CPU cores, GPU memory, entire GPU flag, or multiple GPUs)
5252
3. Defines `inputs()`/`outputs()` to document required attributes and produced attributes on tasks
5353
4. Implements `setup(worker_metadata)` for model initialization and `process(task)` to transform tasks
5454

@@ -75,9 +75,8 @@ Refer to the stage base and resources definitions in Curator for full details.
7575
`Resources` support both fractional and whole‑GPU semantics:
7676

7777
- `gpu_memory_gb`: Request a fraction of a single GPU by memory; Curator rounds to a fractional GPU share and enforces that `gpu_memory_gb` stays within one device.
78-
- `entire_gpu`: Request an entire GPU regardless of memory (also implies access to NVDEC/NVENC on that device).
78+
- `entire_gpu`: Request an entire GPU regardless of memory (also implies access to hardware decoders and encoders on that device).
7979
- `gpus`: Request more than one GPU for a stage that is multi‑GPU aware.
80-
- `nvdecs` / `nvencs`: Request hardware decode/encode units when needed.
8180

8281
Choose one of `gpu_memory_gb` (single‑GPU fractional) or `gpus` (multi‑GPU). Combining both is not allowed.
8382

docs/curate-video/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Understand how components work together so you can plan, scale, and troubleshoot
3333
```
3434

3535
```{note}
36-
Video pipelines use the `XennaExecutor` backend by default, which provides optimized support for GPU-accelerated video processing including hardware decoders (`nvdecs`) and encoders (`nvencs`). You do not need to import or configure the executor unless you want to use an alternative backend. For more information about customizing backends, refer to [Pipeline Execution Backends](reference-execution-backends).
36+
Video pipelines use the `XennaExecutor` backend by default, which provides optimized support for GPU-accelerated video processing including hardware decoders and encoders. You do not need to import or configure the executor unless you want to use an alternative backend. For more information about customizing backends, refer to [Pipeline Execution Backends](reference-execution-backends).
3737
```
3838

3939
---

docs/curate-video/tutorials/pipeline-customization/add-cust-env.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,3 @@ docker build -t my-ray-curator:latest .
7070
## Next Steps
7171

7272
Now that you have created a custom environment, you can [create custom code](video-tutorials-pipeline-cust-add-code) for that environment.
73-
74-
```{note}
75-
Ray Data backends do not support `nvdecs`/`nvencs` resource keys. Xenna does. If you plan to use `nvdecs`/`nvencs`, prefer the default Xenna executor.
76-
```

docs/curate-video/tutorials/pipeline-customization/add-cust-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ The setup method initializes the underlying `MyCore` class that performs the mod
131131

132132
The `model_id_names` property returns a list of weight IDs. These typically correspond to model repository names but do not have to.
133133

134-
If your stage requires a specific environment, manage that in the stages `resources` (for example, `gpu_memory_gb`, `nvdecs`, `nvencs`) and container image, rather than on the model. GPU allocation is managed at the stage level using `Resources`, not on the model.
134+
If your stage requires a specific environment, manage that in the stage's `resources` (for example, `gpu_memory_gb`, `entire_gpu`, or `gpus`) and container image, rather than on the model. GPU allocation is managed at the stage level using `Resources`, not on the model.
135135

136136
### Manage model weights
137137

docs/curate-video/tutorials/pipeline-customization/add-cust-stage.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class MyCustomStage(ProcessingStage[VideoTask, VideoTask]):
6161
from nemo_curator.stages.resources import Resources
6262

6363
stage = MyCustomStage().with_(
64-
resources=Resources(cpus=4.0, gpu_memory_gb=16.0, nvdecs=1, nvencs=1)
64+
resources=Resources(cpus=4.0, gpu_memory_gb=16.0)
6565
)
6666
```
6767

@@ -160,6 +160,3 @@ For end-to-end usage, review and adapt the example:
160160

161161
If you need a container image, extend your base image using a Dockerfile and include your code and dependencies. Then build and run with your preferred container tooling.
162162

163-
```{note}
164-
Ray Data backends do not support `nvdecs`/`nvencs` resource keys. Xenna does. If you plan to use `nvdecs`/`nvencs`, prefer the default Xenna executor.
165-
```

0 commit comments

Comments
 (0)