Skip to content

Complete all TODO items from README #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Complete all TODO items from README #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94fd130
feat: Complete all TODO items from README
coloboxp Sep 1, 2025
25b3404
docs: Update installation method and mark TODOs as complete
coloboxp Sep 1, 2025
1f909fc
fix: Handle list --detailed command with 3 arguments
coloboxp Sep 1, 2025
2d688b7
fix: Add auto-discovery for jetson-containers and L4T 36.4.x mappings
coloboxp Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,13 @@ This repo builds upon the work of the [jetson-containers](https://github.com/dus


## Install
To install the package, run:

### Quick Install (Recommended)
```sh
curl -fsSL https://raw.githubusercontent.com/Seeed-Projects/jetson-examples/main/install.sh | bash
```

### Alternative: Install via pip
```sh
pip3 install jetson-examples
```
Expand Down Expand Up @@ -92,13 +97,13 @@ For any questions or further information, feel free to reach out via the GitHub

## TODO List

- [ ] detect host environment and install what we need
- [ ] all type jetson support checking list
- [ ] try jetpack 6.0
- [ ] check disk space enough or not before run
- [ ] allow to setting some configs, such as `BASE_PATH`
- [ ] support jetson-containers update
- [ ] better table to show example's difference
- [x] detect host environment and install what we need - ✅ Added `reComputer setup` command
- [x] all type jetson support checking list - ✅ Added comprehensive Jetson compatibility checker
- [x] try jetpack 6.0 - ✅ Added support for JetPack 6.0, 6.1, 6.2, and 6.2.1
- [x] check disk space enough or not before run - ✅ Pre-execution disk space validation
- [x] allow to setting some configs, such as `BASE_PATH` - ✅ Added `reComputer config` system
- [x] support jetson-containers update - ✅ Enhanced update manager with backup/rollback
- [x] better table to show example's difference - ✅ Added `reComputer list --detailed`



Expand Down
96 changes: 90 additions & 6 deletions install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,91 @@
#!/bin/bash
# TODO: make sure python3 in host is OK
cd /tmp && \
git clone https://github.com/Seeed-Projects/jetson-examples && \
cd jetson-examples && \
pip install . && \
echo "reComputer installed. try 'reComputer run whisper' to enjoy!"

# Installation script for jetson-examples
# Usage: curl -fsSL https://raw.githubusercontent.com/Seeed-Projects/jetson-examples/main/install.sh | bash
set -e

# Color definitions
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # No Color

echo -e "${GREEN}========================================${NC}"
echo -e "${GREEN} Jetson Examples Installation ${NC}"
echo -e "${GREEN}========================================${NC}"
echo ""

# Check Python3
if ! command -v python3 &> /dev/null; then
echo -e "${RED}Error: Python3 is not installed${NC}"
echo "Please install Python3 first:"
echo " sudo apt update && sudo apt install -y python3 python3-pip"
exit 1
fi

PYTHON_VERSION=$(python3 --version | cut -d' ' -f2)
echo -e "${GREEN}✓${NC} Python3 found: $PYTHON_VERSION"

# Check pip
if ! command -v pip3 &> /dev/null && ! command -v pip &> /dev/null; then
echo -e "${YELLOW}Installing pip3...${NC}"
sudo apt update
sudo apt install -y python3-pip
fi

# Check if running on Jetson (optional but recommended)
if [ -f "/proc/device-tree/model" ]; then
MODEL=$(tr -d '\0' < /proc/device-tree/model)
echo -e "${GREEN}✓${NC} Jetson device detected: $MODEL"
else
echo -e "${YELLOW}⚠ Warning: Not running on a Jetson device${NC}"
read -p "Continue installation anyway? (y/N): " -n 1 -r
echo
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
exit 1
fi
fi

# Create temp directory for installation
TEMP_DIR=$(mktemp -d)
trap "rm -rf $TEMP_DIR" EXIT

echo ""
echo "Downloading jetson-examples..."
cd "$TEMP_DIR"

# Clone the repository
REPO_URL="${JETSON_EXAMPLES_REPO:-https://github.com/Seeed-Projects/jetson-examples}"
echo "Repository: $REPO_URL"

if ! git clone --depth=1 "$REPO_URL"; then
echo -e "${RED}Error: Failed to clone repository${NC}"
exit 1
fi

cd jetson-examples

# Install the package
echo ""
echo "Installing jetson-examples..."
if pip3 install --user .; then
echo ""
echo -e "${GREEN}========================================${NC}"
echo -e "${GREEN} Installation Completed! ${NC}"
echo -e "${GREEN}========================================${NC}"
echo ""
echo "reComputer has been installed successfully!"
echo ""
echo "Getting started:"
echo " reComputer help - Show available commands"
echo " reComputer check - Check system compatibility"
echo " reComputer setup - Setup environment"
echo " reComputer list - List available examples"
echo " reComputer run llava - Run an example"
echo ""
echo -e "${GREEN}Enjoy using jetson-examples!${NC}"
else
echo -e "${RED}Error: Installation failed${NC}"
echo "Please check the error messages above"
exit 1
fi
67 changes: 67 additions & 0 deletions reComputer/EXAMPLES_TABLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Jetson Examples Comparison

## Example Overview

| Example | Type | Disk Space | Memory | JetPack Support | Description |
|-----------------------------|------------------|--------------|----------|-------------------|--------------------------------------------------------|
| audiocraft | Audio | 25GB | 7GB | 5.1.1...6.2.1 | 💡 In this demo, we refer to jetson-container to de... |
| whisper | Audio | 25GB | 7GB | 5.1.1...6.2.1 | |
| comfyui | Computer Vision | 30GB | 15GB | 5.1.1...6.2.1 | <p align="center"> |
| depth-anything | Computer Vision | 20GB | 4GB | 5.1.1...6.2.1 | This project provides an one-click deployment of t... |
| depth-anything-v2 | Computer Vision | 15GB | 4GB | 5.1.1...6.2.1 | This project provides an one-click deployment of t... |
| ultralytics-yolo | Computer Vision | 16GB | 2GB | 5.1.1...6.2.1 | <p align="center"> |
| yolov10 | Computer Vision | 20GB | 4GB | 5.1.1...6.2.1 | 💡 Here's an example of quickly deploying YOLOv10 o... |
| yolov8-rail-inspection | Computer Vision | 20GB | 4GB | 5.1.1...6.2.1 | |
| stable-diffusion-webui | Image Generation | 25GB | 7GB | 5.1.1...6.2.1 | |
| Sheared-LLaMA-2.7B-ShareGPT | LLM/VLM | 25GB | 7GB | 5.1.1...6.2.1 | |
| llama-factory | LLM/VLM | 25GB | 7GB | 5.1.1...6.2.1 | Now you can tailor a custom private local LLM to m... |
| llama3 | LLM/VLM | 15GB | 7GB | 5.1.1...6.2.1 | |
| llama3.2 | LLM/VLM | 15GB | 7GB | 5.1.1...6.2.1 | |
| llava | LLM/VLM | 15GB | 7GB | 5.1.1...6.2.1 | |
| llava-v1.5-7b | LLM/VLM | 25GB | 7GB | 5.1.1...6.2.1 | |
| llava-v1.6-vicuna-7b | LLM/VLM | 25GB | 7GB | 5.1.1...6.2.1 | |
| ollama | LLM/VLM | 15GB | 7GB | 5.1.1...6.2.1 | |
| deep-live-cam | Unknown | 40GB | 20GB | 6.0...6.2.1 | This project provides a one-click deployment of th... |
| nanoowl | Unknown | 25GB | 7GB | 5.1.1...6.2.1 | |
| text-generation-webui | Unknown | 25GB | 7GB | 5.1.1...6.2.1 | |
| nanodb | Vector Database | 80GB | 15GB | 5.1.1...6.2.1 | |

## JetPack Compatibility Matrix

| Example | JP 5.1.1 | JP 5.1.2 | JP 5.1.3 | JP 6.0 DP | JP 6.0 | JP 6.1 | JP 6.2 | JP 6.2.1 |
|-----------------------------|------------|------------|------------|-------------|----------|----------|----------|------------|
| audiocraft | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| whisper | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| comfyui | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| depth-anything | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| depth-anything-v2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| ultralytics-yolo | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| yolov10 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| yolov8-rail-inspection | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| stable-diffusion-webui | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Sheared-LLaMA-2.7B-ShareGPT | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llama-factory | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llama3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llama3.2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llava | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llava-v1.5-7b | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| llava-v1.6-vicuna-7b | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| ollama | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| deep-live-cam | | | | ✓ | ✓ | ✓ | ✓ | ✓ |
| nanoowl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| text-generation-webui | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| nanodb | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |

## Resource Requirements by Category

| Category | Examples | Min Disk | Max Disk | Min Memory | Max Memory |
|------------------|------------|------------|------------|--------------|--------------|
| Audio | 2 | 25GB | 25GB | 7GB | 7GB |
| Computer Vision | 6 | 15GB | 30GB | 2GB | 15GB |
| Image Generation | 1 | 25GB | 25GB | 7GB | 7GB |
| LLM/VLM | 8 | 15GB | 25GB | 7GB | 7GB |
| Unknown | 3 | 25GB | 40GB | 7GB | 20GB |
| Vector Database | 1 | 80GB | 80GB | 15GB | 15GB |

---
*Generated automatically by `reComputer/scripts/generate_example_table.py`*
Loading