Skip to main content

Awesome general_navigation created by AdityaNG

Project description

General Navigation Python Module

PyPI - Downloads PyPI - Version codecov CI GitHub License

Demo

General Navigation Models based on GNM, ViNT, NoMaD as a pytorch repo installable from pip for quick and easy deployment. This repo provides functionality to load and run the models and use MPC to generate steering commands for your robot. If you find any functionality in this repo useful, consider citing it:

@misc{aditya2024general_navigation,
  title        = {General Navigation Python Module},
  author       = {Aditya, NG},
  howpublished = {\url{https://pypi.org/project/general-navigation/}},
  version      = {1.0.0},
  year         = {2024},
  note         = {Accessed: 2024-06-09}
}

Install it from PyPI

PyPi Link

Install our project from pip and quickly get started by trying it out on your own test video!

pip install general_navigation
python3 -m general_navigation --media media/test.mp4

If you want to connect with the Carla simulator, you will also need to seperately install carla

pip install carla==0.9.15  # Linux and Windows
pip install carla==0.9.5  # Mac

Usage

Documentation Link

Creating a pytorch instance of the model

from general_navigation.models.factory import (
  get_default_config, get_model, get_weights
)

config = get_default_config()
model = get_model(config)
model = get_weights(config, model, device)

Using the command line tool for inference on a video

$ python3 -m general_navigation --help
usage: general_navigation [-h] [--device {auto,cuda,cpu}] [--media MEDIA]

options:
  -h, --help            show this help message and exit
  --device {auto,cuda,cpu}, -d {auto,cuda,cpu}
  --media MEDIA, -m MEDIA
                        File path, use camera index if you want to use the webcam
$ python3 -m general_navigation --media media/test.mp4

Using the command line tool for working with Carla simulator

$ python3 -m general_navigation.carla_run

TODO

  • Import models from visualnav-transformer
  • Script to use specified video camera to feed video into the models
  • Visualize model's trajectory output
  • Arguments to CLI
  • Auto download model weights from google drive
  • Demo video
  • PyPi release
  • Example usage
  • Carla Integration
  • MPC implementation
  • Visualize MPC reconstructed trajectory
  • Visualize all of the model's trajectories
  • Visualize Steering angle
  • Fix scaling issue
  • Intrinsic matrix as argument
  • Documentation: mkdocs gh-deploy
  • Linting fixes
  • MyPy testing
  • Add test cases for code coverage

Development

Read the CONTRIBUTING.md file.

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

general_navigation-1.2.0.tar.gz (15.4 MB view details)

Uploaded Source

Built Distribution

general_navigation-1.2.0-py3-none-any.whl (798.2 kB view details)

Uploaded Python 3

File details

Details for the file general_navigation-1.2.0.tar.gz.

File metadata

  • Download URL: general_navigation-1.2.0.tar.gz
  • Upload date:
  • Size: 15.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for general_navigation-1.2.0.tar.gz
Algorithm Hash digest
SHA256 841af4fb75a0503d2d19e266d0f7b2c9497d1244de2e5f666ca8d9d1b77242a1
MD5 c6546d9e587c715b7d2f96c4f494c5cd
BLAKE2b-256 7ee7cebc3215cc24a4160a8e8c04560253bdb00a24533e836e1706d11b19bee9

See more details on using hashes here.

File details

Details for the file general_navigation-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for general_navigation-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68df985a3bcd53952c41c34caaf9a74e890a4b4f2f62f88f485ade217a70949f
MD5 01fc95af20c2b26de85cb194c265f370
BLAKE2b-256 a5e3a738af76d3824f896fe91ddbdaadaeee1acc72ed654355d7bc9ef96ba889

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page