MaixPy (v4)
======
<div align="center">
**Let's Sipeed up, Maximize AI's power!**
**MaixPy** (v4): Easily create AI projects with Python on edge device
<h3>
<a href="https://wiki.sipeed.com/maixpy/doc/en/index.html"> Quick Start </a> |
<a href="https://wiki.sipeed.com/maixpy/en/index.html"> Documentation </a> |
<a href="https://wiki.sipeed.com/maixpy/api/index.html"> API </a> |
<a href="https://wiki.sipeed.com/maixcam"> Hardware </a>
</h3>
[](https://github.com/sipeed/MaixPy/stargazers)
[]("https://github.com/sipeed/MaixPy/blob/main/LICENSE.md)
[](https://pypi.python.org/pypi/maixpy/)
[](https://pypi.org/project/maixpy/)
[](https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml)
[](https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml)
English | [中文](./README_ZH.md)
</div>
> New MaixPy (v4) and new hardware platform MaixCAM is coming now(2024.4)!<br>
> If you have any suggestions, tell us on [MaixHub](https://maixhub.com/discussion/100073), or [Telegram/MaixPy](https://t.me/maixpy) or QQ group: 862340358.
>
> Click the **Star** in the upper right corner to let us know you like it to encourage us to add more features.
## Introduction
With MaixPy you can easily create **AI vision project** within **10 lines of code**:
```python
from maix import camera, display, image, nn
classifier = nn.Classifier(model="/root/models/mobilenetv2.mud")
cam = camera.Camera(classifier.input_width(), classifier.input_height(), classifier.input_format())
dis = display.Display()
while 1:
img = cam.read()
res = classifier.classify(img)
max_idx, max_prob = res[0]
msg = f"{max_prob:5.2f}: {classifier.labels[max_idx]}"
img.draw_string(10, 10, msg, image.COLOR_RED)
dis.show(img)
```
Result video:
<video playsinline controls autoplay loop muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/d06e4f0e-31af-4679-b3bc-1f93cd633af0" type="video/mp4">
Classifier Result video
</video>
Simply use **peripheral** like serial port:
```python
from maix import uart
devices = uart.list_devices()
serial = uart.UART(devices[0], 115200)
serial.write_str("hello world")
print("received:", serial.read(timeout = 2000))
```
We also provide a handy **[MaixVision](https://wiki.sipeed.com/en/maixvision)** workstation software to make development easier and faster:
<video playsinline controls muted preload src="https://github.com/sipeed/MaixPy/assets/8625829/1168a282-d7c2-45bc-9ffb-c00de1ca24f5" type="video/mp4">
MaixVision
</video>
And online AI train platform **[MaixHub](https://maixhub.com)**, one click to train AI model and deploy to MaixCAM even you have no AI knowledge and expensive training equipment.
## Features
Python programing, MaixVision Workstation, AI vision, video streaming, voice recognize, peripheral usage etc.
**Details and videos** visit official site: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)
## Hardware platform MaixCAM
And we provide new powerful hardware platform **[MaixCAM](https://wiki.sipeed.com/maixcam)**:
| CPU | NPU | Memory |
| --- | --- | ------- |
| - 1GHz RISC-V(Linux)/ARM A53<br>- 700MHz RISCV-V(RTOS)<br>- 25~300MHz 8051(LowPower) | 1Tops@INT8 NPU, support BF16<br>support YOLOv5 YOLOv8 etc.| 256MB DDR3 |
| Connecting | Peripheral | MultiMedia | Buy |
| ----------- | ----- | --- | ---- |
| USB2.0/WiFi6/BLE5.4 | IIC/PWM/SPI/UART/WDT/ADC | - 4M Camera<br>- 2.3" 552x368 Touchscreen<br>- H.264/H.265/MJPEG codec | [Sipeed Official Store](https://wiki.sipeed.com/store) |
Chip register level open, more detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)
> * Big core can choose one of RISC-V and ARM A53.
> * **Maix-I K210** series is outdated, MaixPy v4 not support it, use it please visit **[MaixPy-v1](https://github.com/sipeed/maixpy-v1)**
## Who are using MaixPy?
* **AI Algorithm Engineer** who want to deploy your AI model to embedded devices.
> MaixPy provide easy-to-use API to access NPU, and docs to help you develop your AI model.
* **STEM** teacher who want to teach AI and embeded to students.
> MaixPy provide easy-to-use API, PC tools, online AI train service ... Let you focus on teaching AI, not the hardware and complicated software usage.
* **Maker** who want to make some cool projects but don't want to learn complicated hardware and software.
> MaixPy provide Python API, so all you need is learn basic Python syntax, and MaixPy's API is so easy to use, you can make your project even in a few minutes.
* **Engineer** who want to make some projects but want a prototype as soon as possible.
> MaixPy is easy to build projects, and provide corresponding C++ SDK, so you can directly use MaixPy to deploy or transfer Python code to C++ in a few minutes.
* **Students** who want to learn AI, embedded development.
> We provide many docs and tutorials, and lot of open source code, to help you find learning route, and grow up step by step. From simple Python programming to `Vision`, `AI`, `Audio`, `Linux`, `RTOS` etc.
* **Enterprise** who want to develop AI vision products but have no time or engineers to develop complicated embedded system.
> Use MaixPy even graphic programming to develop your products with no more employees and time. For example, add a AI QA system to your production line, or add a AI security monitor to your office as your demand.
* **Contestants** who want to win the competition.
> MaixPy integrate many functions and easy to use, fasten your work to win the competition in limited time. There are already many contestants win the competition with MaixPy.
## Performance comparison
K210 and v831 are outdated, they have many limitations in memory, performance, NPU operators missing etc.<br>
No matter you are using them or new comer, it's recommended to upgrade to MaixCAM and MaixPy v4.<br>
Here's the comparison between them:
| Feature | Maix-I K210 | Maix-II v831 | MaixCAM |
| ------- | ----------- | ------------ | ------- |
| CPU | 400MHz RISC-V x2 | 800MHz ARM7 | **1GHz RISC-V(Linux)<br>700MHz RISC-V(RTOS)<br>25~300MHz 8051(Low Power)** |
| Memory | 6MB SRAM | 64MB DDR2 | **256MB DDR3** |
| NPU | 0.25Tops@INT8<br>official says 1T but... | 0.25Tops@INT8 | **1Tops@INT8** |
| Encoder | ✖ | 1080p@30fps | **2K@30fps** |
| Screen | 2.4" 320x240 | 1.3" 240x240 | **2.28" 552x368** / 5" 1280x720 / 7" 1280x800 / 10“ 1280x800|
| TouchScreen | ✖ | ✖ | **2.3" 552x368** |
| Camera | 30W | 200W | **500W** |
| WiFi | 2.4G | 2.4G | **WiFi6** 2.4G/5G |
| USB | ✖ | **USB2.0** | **USB2.0** |
| Eth | ✖ | 100M(Optional) | 100M(Optional) |
| SD Interface | SPI | **SDIO** | **SDIO** |
| BLE | ✖ | ✖ | **BLE5.4** |
| OS | RTOS | Tina Linux | **Linux + RTOS** |
| Language | C / C++ / MicroPython | C / C++ / **Python3** | C / **C++ / Python3** |
| Software | MaixPy | MaixPy3 | **MaixCDK + MaixPy v4 + opencv + numpy + ...**|
| PC software | MaixPy IDE | MaixPy3 IDE | **MaixVision** Workstation |
| Docs | ⭐️⭐️⭐️⭐️ | ⭐️⭐️⭐️ | 🌟🌟🌟🌟🌟 |
| Online AI train | ⭐️⭐️⭐️ | ⭐️⭐️⭐️⭐️ | 🌟🌟🌟🌟🌟 |
| Official APPs | ⭐️⭐️ | ⭐️⭐️⭐️ | 🌟🌟🌟🌟🌟 |
| AI classify(224x224) | MobileNetv1 50fps<br>MobileNetv2 ✖<br>Resnet ✖ | MobileNet ✖<br>Resnet18 20fps<br>Resnet50 ✖| MobileNetv2 **130fps**<br>Resnet18 **62fps**<br>Resnet50 **28fps** |
| AI detect | YOLOv2(224x224) 15fps | YOLOv2(224x224) 15fps | **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|
| Ease of use | ⭐️⭐️⭐️⭐️ | ⭐️⭐️⭐️ | 🌟🌟🌟🌟🌟 |
## Maix Ecosystem
MaixPy not only a Python SDK, but have a whole ecosystem, including hardware, software, tools, docs, even cloud platform etc.
See the picture below:
## What difference between MaixPy v1, MaixPy3 and MaixPy v4?
* MaixPy v1 use MicroPython programming language, only support Sipeed Maix-I K210 series hardware, have limited third-party packages.
* MaixPy3 is designed for Sipeed Maix-II-Dock v831, not a long-term support version.
* MaixPy v4 use Python programming language, so there's much package we can use directly. MaixPy v4 support new hardware platforms of Sipeed, it's a long-term support version, the future's hardware platforms will support this version. MaixPy v4 have a MaixPy-v1 compatible API, so you can quickly migrate your MaixPy v1 project to MaixPy v4.
(MaixPy v4 Will not support Maix-I K210 series, if you are using Maix-I K210 series, it's recommended to upgrade hardware platform to use this to get more features and better performance.)
## Compile Source Code
If you want to compile MaixPy firmware from source code, refer to [Build MaixPy source code](https://wiki.sipeed.com/maixpy/doc/en/source_code/build.html) page.
## License
All files in this repository are under the terms of the [Apache License 2.0 Sipeed Ltd.](./LICENSE) except the third-party libraries or have their own license.
## Community
* Project sharing: [maixhub.com/share](https://maixhub.com/share)
* Discussion: [maixhub.com/discussion](https://maixhub.com/discussion)
* QQ group: 862340358
* Telegram: [t.me/maixpy](https://t.me/maixpy)
Raw data
{
"_id": null,
"home_page": "https://github.com/Sipeed/MaixPy",
"name": "MaixPy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Machine vision, AI vision, IOT, AIOT, Edge computing",
"author": "Sipeed",
"author_email": "support@sipeed.com",
"download_url": null,
"platform": null,
"description": "MaixPy (v4)\n======\n\n<div align=\"center\">\n\n\n\n**Let's Sipeed up, Maximize AI's power!**\n\n**MaixPy** (v4): Easily create AI projects with Python on edge device\n\n<h3>\n <a href=\"https://wiki.sipeed.com/maixpy/doc/en/index.html\"> Quick Start </a> |\n <a href=\"https://wiki.sipeed.com/maixpy/en/index.html\"> Documentation </a> |\n <a href=\"https://wiki.sipeed.com/maixpy/api/index.html\"> API </a> |\n <a href=\"https://wiki.sipeed.com/maixcam\"> Hardware </a>\n</h3>\n\n[](https://github.com/sipeed/MaixPy/stargazers)\n[](\"https://github.com/sipeed/MaixPy/blob/main/LICENSE.md)\n[](https://pypi.python.org/pypi/maixpy/)\n[](https://pypi.org/project/maixpy/)\n \n[](https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml)\n[](https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml)\n\nEnglish | [\u4e2d\u6587](./README_ZH.md)\n\n</div>\n\n\n> New MaixPy (v4) and new hardware platform MaixCAM is coming now(2024.4)!<br>\n> If you have any suggestions, tell us on [MaixHub](https://maixhub.com/discussion/100073), or [Telegram/MaixPy](https://t.me/maixpy) or QQ group: 862340358.\n>\n> Click the **Star** in the upper right corner to let us know you like it to encourage us to add more features.\n\n\n## Introduction\n\nWith MaixPy you can easily create **AI vision project** within **10 lines of code**:\n\n```python\nfrom maix import camera, display, image, nn\n\nclassifier = nn.Classifier(model=\"/root/models/mobilenetv2.mud\")\ncam = camera.Camera(classifier.input_width(), classifier.input_height(), classifier.input_format())\ndis = display.Display()\n\nwhile 1:\n img = cam.read()\n res = classifier.classify(img)\n max_idx, max_prob = res[0]\n msg = f\"{max_prob:5.2f}: {classifier.labels[max_idx]}\"\n img.draw_string(10, 10, msg, image.COLOR_RED)\n dis.show(img)\n```\n\nResult video:\n\n<video playsinline controls autoplay loop muted preload src=\"https://github.com/sipeed/MaixPy/assets/8625829/d06e4f0e-31af-4679-b3bc-1f93cd633af0\" type=\"video/mp4\">\nClassifier Result video\n</video>\n\nSimply use **peripheral** like serial port:\n\n```python\nfrom maix import uart\n\ndevices = uart.list_devices()\n\nserial = uart.UART(devices[0], 115200)\nserial.write_str(\"hello world\")\nprint(\"received:\", serial.read(timeout = 2000))\n```\n\nWe also provide a handy **[MaixVision](https://wiki.sipeed.com/en/maixvision)** workstation software to make development easier and faster:\n\n<video playsinline controls muted preload src=\"https://github.com/sipeed/MaixPy/assets/8625829/1168a282-d7c2-45bc-9ffb-c00de1ca24f5\" type=\"video/mp4\">\nMaixVision\n</video>\n\nAnd online AI train platform **[MaixHub](https://maixhub.com)**, one click to train AI model and deploy to MaixCAM even you have no AI knowledge and expensive training equipment.\n\n\n\n## Features\n\nPython programing, MaixVision Workstation, AI vision, video streaming, voice recognize, peripheral usage etc.\n\n**Details and videos** visit official site: [wiki.sipeed.com/maixpy/](https://wiki.sipeed.com/maixpy/)\n\n## Hardware platform MaixCAM\n\nAnd we provide new powerful hardware platform **[MaixCAM](https://wiki.sipeed.com/maixcam)**:\n\n\n\n| CPU | NPU | Memory |\n| --- | --- | ------- |\n| - 1GHz RISC-V(Linux)/ARM A53<br>- 700MHz RISCV-V(RTOS)<br>- 25~300MHz 8051(LowPower) | 1Tops@INT8 NPU, support BF16<br>support YOLOv5 YOLOv8 etc.| 256MB DDR3 |\n\n| Connecting | Peripheral | MultiMedia | Buy |\n| ----------- | ----- | --- | ---- |\n| USB2.0/WiFi6/BLE5.4 | IIC/PWM/SPI/UART/WDT/ADC | - 4M Camera<br>- 2.3\" 552x368 Touchscreen<br>- H.264/H.265/MJPEG codec | [Sipeed Official Store](https://wiki.sipeed.com/store) |\n\nChip register level open, more detalils: [MaixCAM](https://wiki.sipeed.com/maixcam)\n\n> * Big core can choose one of RISC-V and ARM A53.\n> * **Maix-I K210** series is outdated, MaixPy v4 not support it, use it please visit **[MaixPy-v1](https://github.com/sipeed/maixpy-v1)**\n\n\n## Who are using MaixPy?\n\n* **AI Algorithm Engineer** who want to deploy your AI model to embedded devices.\n> MaixPy provide easy-to-use API to access NPU, and docs to help you develop your AI model.\n* **STEM** teacher who want to teach AI and embeded to students.\n> MaixPy provide easy-to-use API, PC tools, online AI train service ... Let you focus on teaching AI, not the hardware and complicated software usage.\n* **Maker** who want to make some cool projects but don't want to learn complicated hardware and software.\n> MaixPy provide Python API, so all you need is learn basic Python syntax, and MaixPy's API is so easy to use, you can make your project even in a few minutes.\n* **Engineer** who want to make some projects but want a prototype as soon as possible.\n> MaixPy is easy to build projects, and provide corresponding C++ SDK, so you can directly use MaixPy to deploy or transfer Python code to C++ in a few minutes.\n* **Students** who want to learn AI, embedded development.\n> We provide many docs and tutorials, and lot of open source code, to help you find learning route, and grow up step by step. From simple Python programming to `Vision`, `AI`, `Audio`, `Linux`, `RTOS` etc.\n* **Enterprise** who want to develop AI vision products but have no time or engineers to develop complicated embedded system.\n> Use MaixPy even graphic programming to develop your products with no more employees and time. For example, add a AI QA system to your production line, or add a AI security monitor to your office as your demand.\n* **Contestants** who want to win the competition.\n> MaixPy integrate many functions and easy to use, fasten your work to win the competition in limited time. There are already many contestants win the competition with MaixPy.\n\n\n## Performance comparison\n\nK210 and v831 are outdated, they have many limitations in memory, performance, NPU operators missing etc.<br>\nNo matter you are using them or new comer, it's recommended to upgrade to MaixCAM and MaixPy v4.<br>\n\nHere's the comparison between them:\n\n| Feature | Maix-I K210 | Maix-II v831 | MaixCAM |\n| ------- | ----------- | ------------ | ------- |\n| CPU | 400MHz RISC-V x2 | 800MHz ARM7 | **1GHz RISC-V(Linux)<br>700MHz RISC-V(RTOS)<br>25~300MHz 8051(Low Power)** |\n| Memory | 6MB SRAM | 64MB DDR2 | **256MB DDR3** |\n| NPU | 0.25Tops@INT8<br>official says 1T but... | 0.25Tops@INT8 | **1Tops@INT8** |\n| Encoder | \u2716 | 1080p@30fps | **2K@30fps** |\n| Screen | 2.4\" 320x240 | 1.3\" 240x240 | **2.28\" 552x368** / 5\" 1280x720 / 7\" 1280x800 / 10\u201c 1280x800|\n| TouchScreen | \u2716 | \u2716 | **2.3\" 552x368** |\n| Camera | 30W | 200W | **500W** |\n| WiFi | 2.4G | 2.4G | **WiFi6** 2.4G/5G |\n| USB | \u2716 | **USB2.0** | **USB2.0** |\n| Eth | \u2716 | 100M(Optional) | 100M(Optional) |\n| SD Interface | SPI | **SDIO** | **SDIO** |\n| BLE | \u2716 | \u2716 | **BLE5.4** |\n| OS | RTOS | Tina Linux | **Linux + RTOS** |\n| Language | C / C++ / MicroPython | C / C++ / **Python3** | C / **C++ / Python3** |\n| Software | MaixPy | MaixPy3 | **MaixCDK + MaixPy v4 + opencv + numpy + ...**|\n| PC software | MaixPy IDE | MaixPy3 IDE | **MaixVision** Workstation |\n| Docs | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f |\n| Online AI train | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f |\n| Official APPs | \u2b50\ufe0f\u2b50\ufe0f | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f |\n| AI classify(224x224) | MobileNetv1 50fps<br>MobileNetv2 \u2716<br>Resnet \u2716 | MobileNet \u2716<br>Resnet18 20fps<br>Resnet50 \u2716| MobileNetv2 **130fps**<br>Resnet18 **62fps**<br>Resnet50 **28fps** |\n| AI detect | YOLOv2(224x224) 15fps | YOLOv2(224x224) 15fps | **YOLOv5s(224x224) 100fps<br>YOLOv5s(320x256) 70fps<br>YOLOv5s(640x640) 15fps<br>YOLOv8n(640x640) 23fps**|\n| Ease of use | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \u2b50\ufe0f\u2b50\ufe0f\u2b50\ufe0f | \ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f\ud83c\udf1f |\n\n## Maix Ecosystem\n\nMaixPy not only a Python SDK, but have a whole ecosystem, including hardware, software, tools, docs, even cloud platform etc.\nSee the picture below:\n\n\n\n\n## What difference between MaixPy v1, MaixPy3 and MaixPy v4?\n\n* MaixPy v1 use MicroPython programming language, only support Sipeed Maix-I K210 series hardware, have limited third-party packages.\n* MaixPy3 is designed for Sipeed Maix-II-Dock v831, not a long-term support version.\n* MaixPy v4 use Python programming language, so there's much package we can use directly. MaixPy v4 support new hardware platforms of Sipeed, it's a long-term support version, the future's hardware platforms will support this version. MaixPy v4 have a MaixPy-v1 compatible API, so you can quickly migrate your MaixPy v1 project to MaixPy v4.\n\n(MaixPy v4 Will not support Maix-I K210 series, if you are using Maix-I K210 series, it's recommended to upgrade hardware platform to use this to get more features and better performance.)\n\n## Compile Source Code\n\nIf you want to compile MaixPy firmware from source code, refer to [Build MaixPy source code](https://wiki.sipeed.com/maixpy/doc/en/source_code/build.html) page.\n\n\n## License\n\nAll files in this repository are under the terms of the [Apache License 2.0 Sipeed Ltd.](./LICENSE) except the third-party libraries or have their own license.\n\n\n## Community\n\n* Project sharing: [maixhub.com/share](https://maixhub.com/share)\n* Discussion: [maixhub.com/discussion](https://maixhub.com/discussion)\n* QQ group: 862340358\n* Telegram: [t.me/maixpy](https://t.me/maixpy)\n\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Sipeed Maix Vision Python SDK",
"version": "4.1.4",
"project_urls": {
"Homepage": "https://github.com/Sipeed/MaixPy"
},
"split_keywords": [
"machine vision",
" ai vision",
" iot",
" aiot",
" edge computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "772fb163c84788a3aa2f4966435eba669837a6c01a73f8935ceee4c17dd2f1e2",
"md5": "f68243ca9e4a6eec59853297ee1432cd",
"sha256": "a2e1fdbfff8c1c12851a2f95696750390789d1c591b93d66328446d59731e0ed"
},
"downloads": -1,
"filename": "MaixPy-4.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f68243ca9e4a6eec59853297ee1432cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10437674,
"upload_time": "2024-05-16T11:22:57",
"upload_time_iso_8601": "2024-05-16T11:22:57.159809Z",
"url": "https://files.pythonhosted.org/packages/77/2f/b163c84788a3aa2f4966435eba669837a6c01a73f8935ceee4c17dd2f1e2/MaixPy-4.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-16 11:22:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sipeed",
"github_project": "MaixPy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "maixpy"
}
JSON
