Skip to content

Commit

Permalink
Merge pull request #12 from nasongCool/main
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
nasongCool authored Jan 3, 2025
2 parents 1d081a2 + 66453c5 commit efe01ee
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,39 @@
# QRB ROS NN Inference
![Static Badge](https://img.shields.io/badge/language-Cpp-green)
![Static Badge](https://img.shields.io/badge/executor-CPU_GPU_HTP-orange)
![Static Badge](https://img.shields.io/badge/release-v0.2.0-blue)

## Overview
🎉 Explore your AI robot applications on Qualcomm devices!

qrb_ros_nn_inference is a ros2 package for performing neural network model, providing AI-based perception for robotics applications.<br> qrb_ros_nn_inference offers hardware acceleration based on Qualcomm platforms, utilizing pre-trained models from the Qualcomm AI Hub to receive input tensor and output the prediction to output tensor.
## 🙋‍♂️ Overview

## Documentation
**qrb_ros_nn_inference** is a ROS2 package for performing neural network model, providing 🤖AI-based perception for robotics applications.<br>

qrb_ros_nn_inference support:
- 🚀hardware acceleration based on Qualcomm platforms
- ✨three kinds of model format: **.tflite**, **.so**, **.bin**

## 📝 Documentation
Please refer to the [QRB ROS Documentation](https://quic-qrb-ros.github.io/) for more documents.
- [Getting Started](https://quic-qrb-ros.github.io/getting_started/index.html)
- [QRB ROS Packages](https://quic-qrb-ros.github.io/packages/index.html)
- [Release Notes](https://quic-qrb-ros.github.io/release_notes/index.html)

## Contributing
## 🙏 Contributing

We would love to have you as a part of the QRB ROS community. Whether you are helping us fix bugs, proposing new features, improving our documentation, or spreading the word, please refer to our [contribution guidelines](./CONTRIBUTING.md) and [code of conduct](./CODE_OF_CONDUCT.md).
We so much would love to have you as a part of the QRB ROS community. Whether you are helping us fix bugs, proposing new features, improving our documentation, or spreading the word, please refer to our [contribution guidelines](./CONTRIBUTING.md) and [code of conduct](./CODE_OF_CONDUCT.md).

- Bug report: If you see an error message or encounter failures, please create a [bug report](../../issues)
- Feature Request: If you have an idea or if there is a capability that is missing and would make development easier and more robust, please submit a [feature request](../../issues)

<Update link with template>

## Authors
## 👨‍💻 Authors

* **Na Song** - *Initial work* - [@nasongCool](https://github.com/nasongCool)

See also the list of [contributors](https://github.com/quic-qrb-ros/qrb_ros_nn_inference/graphs/contributors) who participated in this project.

## License
## 📃 License

Project is licensed under the [BSD-3-clause License](https://spdx.org/licenses/BSD-3-Clause.html). See [LICENSE](./LICENSE) for the full license text.

0 comments on commit efe01ee

Please sign in to comment.