chore: import upstream snapshot with attribution
CPU tests Workflow / Testing (ubuntu-latest, 3.12) (push) Failing after 1s
CPU tests Workflow / Testing (ubuntu-latest, 3.13) (push) Failing after 0s
Mypy Type Check / Type Check (push) Failing after 0s
Docs/Test WorkFlow / Test docs build (push) Failing after 1s
PR Conflict Labeler / labeling (push) Failing after 1s
Dependency resolution / Resolve [tflite] extra — Python 3.12 (push) Failing after 0s
Smoke Tests / try-all-models (ubuntu-latest, 3.10) (push) Failing after 0s
Smoke Tests / try-all-models (ubuntu-latest, 3.13) (push) Failing after 1s
CPU tests Workflow / build-pkg (push) Failing after 1s
CPU tests Workflow / Testing (ubuntu-latest, 3.10) (push) Failing after 0s
CPU tests Workflow / Testing (ubuntu-latest, 3.11) (push) Failing after 0s
Smoke Tests / try-all-models (macos-latest, 3.10) (push) Has been cancelled
Smoke Tests / try-all-models (macos-latest, 3.13) (push) Has been cancelled
Smoke Tests / try-all-models (windows-latest, 3.10) (push) Has been cancelled
Smoke Tests / try-all-models (windows-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / Testing (macos-latest, 3.10) (push) Has been cancelled
CPU tests Workflow / Testing (macos-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / Testing (windows-latest, 3.10) (push) Has been cancelled
CPU tests Workflow / Testing (windows-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / testing-guardian (push) Has been cancelled
GPU tests Workflow / Testing (push) Has been cancelled
CPU tests Workflow / Testing (ubuntu-latest, 3.12) (push) Failing after 1s
CPU tests Workflow / Testing (ubuntu-latest, 3.13) (push) Failing after 0s
Mypy Type Check / Type Check (push) Failing after 0s
Docs/Test WorkFlow / Test docs build (push) Failing after 1s
PR Conflict Labeler / labeling (push) Failing after 1s
Dependency resolution / Resolve [tflite] extra — Python 3.12 (push) Failing after 0s
Smoke Tests / try-all-models (ubuntu-latest, 3.10) (push) Failing after 0s
Smoke Tests / try-all-models (ubuntu-latest, 3.13) (push) Failing after 1s
CPU tests Workflow / build-pkg (push) Failing after 1s
CPU tests Workflow / Testing (ubuntu-latest, 3.10) (push) Failing after 0s
CPU tests Workflow / Testing (ubuntu-latest, 3.11) (push) Failing after 0s
Smoke Tests / try-all-models (macos-latest, 3.10) (push) Has been cancelled
Smoke Tests / try-all-models (macos-latest, 3.13) (push) Has been cancelled
Smoke Tests / try-all-models (windows-latest, 3.10) (push) Has been cancelled
Smoke Tests / try-all-models (windows-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / Testing (macos-latest, 3.10) (push) Has been cancelled
CPU tests Workflow / Testing (macos-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / Testing (windows-latest, 3.10) (push) Has been cancelled
CPU tests Workflow / Testing (windows-latest, 3.13) (push) Has been cancelled
CPU tests Workflow / testing-guardian (push) Has been cancelled
GPU tests Workflow / Testing (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
---
|
||||
description: RF-DETR 2XLarge API reference for the highest-accuracy detection model. Requires rfdetr[plus] and the Platform Model License.
|
||||
---
|
||||
|
||||
!!! warning "License Notice"
|
||||
This model is licensed under the Platform Model License (PML-1.0) and requires `pip install rfdetr[plus]`. See the [rfdetr_plus repository](https://github.com/roboflow/rf-detr-plus) for license details.
|
||||
|
||||
:::rfdetr.platform.models.RFDETR2XLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: KeypointTrainConfig API reference for configuring RF-DETR keypoint training parameters with keypoint loss coefficients and optimization settings.
|
||||
---
|
||||
|
||||
:::rfdetr.config.KeypointTrainConfig
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: API reference for the RF-DETR keypoint preview model — keypoint prediction and fine-tuning with inherited training and inference methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRKeypointPreview
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Large API reference for high-accuracy real-time object detection with inherited training, prediction, export, and deployment methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Medium API reference for balanced real-time object detection with inherited training, prediction, export, and deployment methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRMedium
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Nano API reference for the fastest real-time object detection model with inherited training, prediction, export, and deployment methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRNano
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
description: RFDETR base class API reference covering common train, predict, export, optimize, and deploy methods for RF-DETR models.
|
||||
---
|
||||
|
||||
:::rfdetr.detr.RFDETR
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg 2XLarge API reference for the highest-accuracy instance segmentation model with inherited training and inference methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSeg2XLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg Large API reference for high-accuracy real-time instance segmentation with inherited training and inference methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSegLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg Medium API reference for balanced real-time instance segmentation with inherited training and inference methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSegMedium
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg Nano API reference for the fastest instance segmentation model with inherited training, prediction, and export methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSegNano
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg Small API reference for efficient real-time instance segmentation with inherited training and inference methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSegSmall
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Seg XLarge API reference for high-capacity instance segmentation with inherited training, prediction, and export methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSegXLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: SegmentationTrainConfig API reference for configuring RF-DETR segmentation training parameters, dataset options, and optimization settings.
|
||||
---
|
||||
|
||||
:::rfdetr.config.SegmentationTrainConfig
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: RF-DETR Small API reference for efficient real-time object detection with inherited training, prediction, export, and deployment methods.
|
||||
---
|
||||
|
||||
:::rfdetr.variants.RFDETRSmall
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
description: TrainConfig API reference for RF-DETR detection training parameters, dataset configuration, optimization settings, and checkpoint behavior.
|
||||
---
|
||||
|
||||
:::rfdetr.config.TrainConfig
|
||||
options:
|
||||
inherited_members: true
|
||||
@@ -0,0 +1,126 @@
|
||||
---
|
||||
description: RF-DETR Lightning training API reference for RFDETRModelModule, RFDETRDataModule, build_trainer, callbacks, and training primitives.
|
||||
---
|
||||
|
||||
# Training API Reference
|
||||
|
||||
This page documents the training primitives that power RF-DETR. For a narrative guide with runnable examples, see [Custom Training API](../learn/train/customization.md).
|
||||
|
||||
## RFDETRModelModule
|
||||
|
||||
::: rfdetr.training.module_model.RFDETRModelModule
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
- on_fit_start
|
||||
- on_train_batch_start
|
||||
- transfer_batch_to_device
|
||||
- training_step
|
||||
- validation_step
|
||||
- test_step
|
||||
- predict_step
|
||||
- configure_optimizers
|
||||
- clip_gradients
|
||||
- on_load_checkpoint
|
||||
- reinitialize_detection_head
|
||||
|
||||
---
|
||||
|
||||
## RFDETRDataModule
|
||||
|
||||
::: rfdetr.training.module_data.RFDETRDataModule
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
- setup
|
||||
- train_dataloader
|
||||
- val_dataloader
|
||||
- test_dataloader
|
||||
- class_names
|
||||
|
||||
---
|
||||
|
||||
## build_trainer
|
||||
|
||||
::: rfdetr.training.trainer.build_trainer
|
||||
options:
|
||||
show_source: false
|
||||
|
||||
---
|
||||
|
||||
## Callbacks
|
||||
|
||||
### RFDETREMACallback
|
||||
|
||||
::: rfdetr.training.callbacks.ema.RFDETREMACallback
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
|
||||
### BestModelCallback
|
||||
|
||||
::: rfdetr.training.callbacks.best_model.BestModelCallback
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
|
||||
### RFDETREarlyStopping
|
||||
|
||||
::: rfdetr.training.callbacks.best_model.RFDETREarlyStopping
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
|
||||
### DropPathCallback
|
||||
|
||||
::: rfdetr.training.callbacks.drop_schedule.DropPathCallback
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
|
||||
### COCOEvalCallback
|
||||
|
||||
::: rfdetr.training.callbacks.coco_eval.COCOEvalCallback
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
|
||||
---
|
||||
|
||||
## RFDETRCli
|
||||
|
||||
!!! info "CLI requires the `train` and `cli` extras"
|
||||
|
||||
```bash
|
||||
pip install "rfdetr[train,cli]"
|
||||
```
|
||||
|
||||
The `rfdetr` console script and its `--config` / `--print_config` flags are provided by `jsonargparse`, which is included in the `cli` extra.
|
||||
|
||||
`RFDETRCli` is the command-line entry point for RF-DETR. It wraps
|
||||
`RFDETRModelModule` and `RFDETRDataModule` under a single `rfdetr` command and
|
||||
auto-generates four subcommands from the PyTorch Lightning CLI machinery:
|
||||
|
||||
```bash
|
||||
rfdetr fit --config configs/rfdetr_base.yaml
|
||||
rfdetr validate --ckpt_path output/best.ckpt
|
||||
rfdetr test --ckpt_path output/best.ckpt
|
||||
rfdetr predict --ckpt_path output/best.ckpt
|
||||
```
|
||||
|
||||
Both `model_config` and `train_config` are specified once; `RFDETRCli`
|
||||
automatically links them to the datamodule so you do not need to repeat the
|
||||
same arguments under `--data.*`.
|
||||
|
||||
::: rfdetr.training.cli.RFDETRCli
|
||||
options:
|
||||
show_source: false
|
||||
members:
|
||||
- __init__
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
description: RF-DETR XLarge API reference for high-capacity detection. Requires rfdetr[plus] and the Platform Model License.
|
||||
---
|
||||
|
||||
!!! warning "License Notice"
|
||||
This model is licensed under the Platform Model License (PML-1.0) and requires `pip install rfdetr[plus]`. See the [rfdetr_plus repository](https://github.com/roboflow/rf-detr-plus) for license details.
|
||||
|
||||
:::rfdetr.platform.models.RFDETRXLarge
|
||||
options:
|
||||
inherited_members: true
|
||||
Reference in New Issue
Block a user