Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary
Keywords
Repository
The "you only glance once" object detection model
Basic Info
Statistics
- Stars: 11
- Watchers: 5
- Forks: 3
- Open Issues: 9
- Releases: 1
Topics
Metadata Files
README.md
you only glance once
A version of the YOLO architecture (versions 1 through 3), optimized for inference speed on simple object detection problems. Designed for the remoscope project by the bioengineering team at the Chan-Zuckerberg Biohub SF.
Our yogo manuscript is currently in preparation - stay tuned!
Install
With Python versions >= 3.9 and < 3.11, you can install yogo with pip
console
python3 -m pip install -e yogo
For developing YOGO, clone the repo and then run
console
python3 -m pip install -e ".[dev]"
Basic usage
console
$ yogo train path/to/dataset-definition-file.yml # train your model!
$ yogo infer path/to/model.pth # use your model!
$ yogo export path/to/model.pth # use your model somewhere else!
$ yogo test path/to/model.pth path/to/dataset-definition-file. # test your model!
$ yogo --help # all the other details are here :)
We're using Weights and Biases for run tracking. But, note that you do not need a W&B account to run anything! Runs that are started without an account are logged to an anonymous page. If you do decide to start with W&B, look here. Anonymous runs can be claimed later.
Further, we currently only support GPU training, since we use Torch's Distributed Data Parallel.
[!NOTE] Installing Openvino on Apple Silicon is a little involved. Here is Openvino's guide to installation. You can also use a Linux VM or Docker.
Docs
Documentation for YOGO. If you want documentation in a specific area, let us know!
- recipes.md has the basics of using YOGO in your own code
- cli.md is a short guide on how to use YOGO from the command line (via
yogo) - yogo-high-level.md is a high level guide of the YOGO architecture
- dataset-definition.md defines the dataset description files, the files YOGO uses to define datasets for training
Contributing Guidelines
Please run ./prepush.sh before pushing. It runs mypy, ruff, black and pytest.
When creating issues or pull requests, please be detailed. What exact commands were you running on what computer to get your issue? What exactly does your PR contribute and why is it necessary?
Owner
- Name: Chan Zuckerberg Biohub San Francisco
- Login: czbiohub-sf
- Kind: organization
- Location: San Francisco
- Website: https://www.czbiohub.org/sf/
- Repositories: 1
- Profile: https://github.com/czbiohub-sf
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: yogo
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Axel
family-names: Jacobsen
email: axelnjacobsen@gmail.com
orcid: 'https://orcid.org/0009-0006-5056-3065'
- given-names: Paul Martin
family-names: Lebel
email: paul.lebel@czbiohub.org
name-particle: Paul
affiliation: Chan Zuckerberg Biohub SF
orcid: 'https://orcid.org/0000-0003-4569-1493'
- given-names: Aditi
family-names: Saxena
email: aditisaxena2000@gmail.com
orcid: 'https://orcid.org/0000-0001-5736-5180'
- given-names: Ilakkiyan
family-names: Jeyakumar
email: ilakkiyan.jeyakumar@czbiohub.org
affiliation: Chan Zuckerberg Biohub SF
orcid: 'https://orcid.org/0000-0002-6973-9167'
- given-names: Rafael
family-names: Gomez-Sjoberg
email: rafael.gomez@czbiohub.org
affiliation: Chan Zuckerberg Biohub SF
orcid: 'https://orcid.org/0000-0001-8017-9669'
GitHub Events
Total
Last Year
Packages
- Total packages: 1
-
Total downloads:
- pypi 9 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: yogo
The "you only glance once" object detection model
- Documentation: https://yogo.readthedocs.io/
- License: BSD 3-Clause License Copyright (c) 2023, Chan-Zuckerberg Biohub All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
Latest release: 1.0.0
published about 2 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- psf/black stable composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- black >=24.4.2 develop
- mypy ^1.10.0 develop
- pytest ^7.4.3 develop
- ruff ^0.4.4 develop
- MonkeyType 23.3.0
- matplotlib ^3.4.2
- onnx >=1.14.0
- onnx-simplifier >=0.4.17
- onnxruntime >=1.14.1
- openvino-dev 2023.0.2
- python >=3.9,<3.11
- ruamel.yaml 0.17.21
- torch >=1.13.1,<=2.1.0
- torchmetrics >=0.11.4
- torchvision >=0.14.1
- tqdm ^4.61.2
- wandb >=0.14.2
- zarr 2.17