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

Readme and File Cleanup #3

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
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
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.
Empty file removed data/.gitkeep
Empty file.
267 changes: 0 additions & 267 deletions examples/CIFAR_10_dataset.ipynb

This file was deleted.

Loading
Loading