Skip to content

Commit

Permalink
v0.3.0 - Metadata Update (#149)
Browse files Browse the repository at this point in the history
  • Loading branch information
kozlov721 committed Aug 19, 2024
1 parent 3ff7872 commit 012d14b
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 348 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Successful tests are required for merging a PR.
1. Commit (pre-commit hook will run).
1. Push to your branch and create a pull request. Always request a review from:
- [Martin Kozlovský](https://github.com/kozlov721)
- [Klemen Skrlj](https://github.com/klemen1999)
- [Matija Teršek](https://github.com/tersekmatija)
- [Conor Simmons](https://github.com/conorsim)
1. Any other relevant team members can be added as reviewers as well.
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,18 @@

This library includes a collection of helper functions and utilities for the Luxonis MLOps stack. This includes the following submodules:

- **Dataset Management**: Creating computer vision datasets focused around Luxonis hardware and loading data into our training library.
- **Dataset Management**: Creating computer vision datasets focused around Luxonis hardware and to be used with our [LuxonisTrain](https://pypi.org/project/luxonis-train/) framework.
- **Embeddings**: Methods to compute image embeddings.
- **Tracking**: Our implementation of a logger for use with PyTorch Lightning or in our training library.
- **Utils**: Miscellaneous utils for developers. See this README for details on the different utils.
- **Tracking**: Our implementation of a logger for use with PyTorch Lightning or in [LuxonisTrain](https://pypi.org/project/luxonis-train/)
- **Utils**: Miscellaneous utils for developers.

**NOTE**:
The project is in an alpha state, so it may be missing some critical features or contain bugs - please report any feedback!
The project is in a beta state, it might be missing certain features or contain bugs - please report any feedback!

## Table of Contents

- [Installation](#installation)
- [CLI](#cli)
- [Contributing](#contributing)

## Installation
Expand All @@ -46,6 +47,16 @@ To install the package with all dependecies, run:
pip install luxonis-ml[all]
```

## CLI

The `luxonis-ml` package comes with a CLI that can be used to interact with the library.

To see the available commands, run:

```bash
luxonis_ml --help
```

## Contributing

If you want to contribute to this project, read the instructions in [CONTRIBUTING.md](https://github.com/luxonis/luxonis-ml/blob/main/CONTRIBUTING.md)
347 changes: 15 additions & 332 deletions examples/Data_Custom_Example.ipynb

Large diffs are not rendered by default.

14 changes: 4 additions & 10 deletions examples/Data_Parser_Example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,12 @@
"\n",
"if not os.path.exists(dataset_dir):\n",
" Path(dataset_dir).mkdir(parents=True)\n",
"# Check if the data already exists\n",
"if not os.path.exists(output_zip) and not os.path.exists(\n",
" os.path.join(dataset_dir, \"COCO_people_subset\")\n",
"):\n",
" # Download the file\n",
"\n",
"if not os.path.exists(output_zip):\n",
" gdown.download(url, output_zip, quiet=False)\n",
"\n",
" # Unzip the file\n",
" with zipfile.ZipFile(output_zip, \"r\") as zip_ref:\n",
" zip_ref.extractall(dataset_dir)\n",
"else:\n",
" print(\"Data already exists. Exiting.\")"
"with zipfile.ZipFile(output_zip, \"r\") as zip_ref:\n",
" zip_ref.extractall(dataset_dir)"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "luxonis-ml"
version = "0.2.3"
version = "0.3.0"
description = "MLOps tools for training models for Luxonis devices"
readme = "README.md"
requires-python = ">=3.8"
Expand All @@ -11,7 +11,7 @@ keywords = ["ml", "ops", "camera", "luxonis", "oak"]
dynamic = ["dependencies", "optional-dependencies"]
classifiers = [
"License :: OSI Approved :: Apache Software License",
"Development Status :: 3 - Alpha",
"Development Status :: 3 - Beta",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
Expand Down

0 comments on commit 012d14b

Please sign in to comment.