Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ConfigurationFile.md #583

Merged
merged 1 commit into from
Dec 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions docs/ConfigurationFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,46 @@ Deepforest comes with a sample config file, deepforest_config.yml. Edit this fil
the config.yml must be updated instead of updating the dictionary of an already loaded model.

```
# Config file for DeepForest module
# Config file for DeepForest pytorch module

#cpu workers for data loaders
#Dataloaders
# Cpu workers for data loaders
# Dataloaders
workers: 1
devices: auto
accelerator: auto
batch_size: 1

#Non-max supression of overlapping predictions
# Model Architecture
architecture: 'retinanet'
num_classes: 1
nms_thresh: 0.05
score_thresh: 0.1

train:
# Architecture specific params
retinanet:
# Non-max supression of overlapping predictions
score_thresh: 0.1

train:
csv_file:
root_dir:

#Optomizer initial learning rate
# Optimizer initial learning rate
lr: 0.001

#Print loss every n epochs
# Print loss every n epochs
epochs: 1
#Useful debugging flag in pytorch lightning, set to True to get a single batch of training to test settings.
# Useful debugging flag in pytorch lightning, set to True to get a single batch of training to test settings.
fast_dev_run: False
# pin images to GPU memory for fast training. This depends on GPU size and number of images.
preload_images: False

validation:
#callback args
# callback args
csv_file:
root_dir:
#Intersection over union evaluation
# Intersection over union evaluation
iou_threshold: 0.4
val_accuracy_interval: 5
val_accuracy_interval: 20
```

## Dataloaders
Expand Down
Loading