Skip to content

Commit

Permalink
instructions on LDF
Browse files Browse the repository at this point in the history
  • Loading branch information
kozlov721 committed Jan 16, 2024
1 parent d176c4f commit f0eef56
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

Luxonis training framework (`luxonis-train`) is intended for training deep learning models that can run fast on OAK products.

The project is in alpha state - please report any feedback.
**The project is in an alpha state - please report any feedback.**

## Table Of Contents

Expand Down Expand Up @@ -42,6 +42,14 @@ The entire configuration is specified in a `yaml` file. This includes the model
structure, used losses, metrics, optimizers etc. For specific instructions and example
configuration files, see [Configuration](https://github.com/luxonis/luxonis-train/blob/main/configs/README.md).

### Data Preparation

This library requires data to be in the Luxonis Dataset Format.

For instructions on how to create a dataset in the LDF, follow the
[examples](https://github.com/luxonis/luxonis-ml/tree/main/examples) in
the [luxonis-ml](https://github.com/luxonis/luxonis-ml) repository.

## Training

Once you've created your `config.yaml` file you can train the model using this command:
Expand Down Expand Up @@ -127,7 +135,7 @@ class CustomLoss(BaseLoss):
...
```

And then in the config you reference this `CustomOptimizer` and `CustomLoss` by their names.
And then in the config you reference this `CustomOptimizer` and `CustomLoss` by their names:

```yaml
losses:
Expand Down Expand Up @@ -193,4 +201,4 @@ If you want to contribute to the development, install the dev version of the pac
pip install luxonis-train[dev]
```

Consult the [Contribution guide](https://github.com/luxonis/luxonis-train/blob/main/CONTRIBUTING.md) before making a pull request.
Consult the [Contribution guide](https://github.com/luxonis/luxonis-train/blob/main/CONTRIBUTING.md) for further instructions.

0 comments on commit f0eef56

Please sign in to comment.