Skip to content

Commit 8ef328f

Browse files
committed
update README.
1 parent 7fead04 commit 8ef328f

2 files changed

Lines changed: 140 additions & 278 deletions

File tree

docs/README.md

Lines changed: 69 additions & 138 deletions
Original file line numberDiff line numberDiff line change
@@ -8,141 +8,72 @@ Live Demo: https://flagopen.github.io/RoboCOIN-DataManager/
88

99
## What is RoboCOIN DataManager?
1010

11-
RoboCOIN DataManager is a user-friendly web application designed to help you easily browse, explore, and download datasets from the RoboCOIN project. Whether you're a researcher, developer, or robotics enthusiast, this tool provides an intuitive interface to discover and obtain the robotic manipulation data you need for your projects.
12-
13-
### Key Features
14-
- **Browse RoboCOIN Datasets**: Explore hundreds of robotic manipulation episodes with video previews
15-
- **Advanced Filtering**: Find specific datasets by scene, robot type, actions, and objects
16-
- **Video Previews**: Watch short video clips of robotic tasks directly in your browser
17-
- **Batch Download**: Select multiple datasets and generate download commands for bulk acquisition
18-
- **Multi-Source Support**: Download from both ModelScope and HuggingFace repositories
19-
20-
> ⚠️ **Important**: Before downloading datasets through this web interface, please install the [RoboCOIN project](https://github.com/FlagOpen/RoboCOIN) to get the best download experience with pre-built batch download scripts:
21-
> ```bash
22-
> pip install robocoin
23-
> ```
24-
25-
## How the Web App Works
26-
27-
This web application loads RoboCOIN dataset information directly in your browser and provides an interactive interface to explore and select datasets. Here's how it works:
28-
29-
### Data Loading Process
30-
1. **Dataset Discovery**: The app loads metadata for all available RoboCOIN datasets
31-
2. **Video Previews**: Short video clips are loaded for previewing robotic tasks
32-
3. **Interactive Filtering**: You can filter datasets by various criteria like robot types, scenes, and actions
33-
4. **Download Generation**: Selected datasets are used to generate Python download commands
34-
35-
### Browser Requirements
36-
- **Modern Browsers**: Chrome 61+, Firefox 60+, Safari 11+, Edge 61+, or Opera 48+
37-
- **JavaScript**: Must be enabled (the app uses modern ES6 modules)
38-
- **Internet Connection**: Required for loading dataset information and video previews
39-
40-
## Main Features
41-
42-
### 1. Dataset Exploration
43-
- **Visual Previews**: Watch short video clips of robotic manipulation tasks
44-
- **Detailed Information**: View comprehensive metadata for each dataset including robot types, scenes, actions, and objects
45-
- **Responsive Design**: Works seamlessly on desktop, tablet, and mobile devices
46-
47-
### 2. Smart Filtering System
48-
- **Multiple Filter Categories**: Filter datasets by scene, robot model, end-effector, action type, and manipulated objects
49-
- **Real-time Search**: Search datasets by name with instant filtering
50-
- **Filter Combinations**: Combine multiple filters to find exactly the datasets you need
51-
- **Quick Reset**: Easily clear all filters with one click
52-
53-
### 3. Dataset Selection and Management
54-
- **Visual Selection**: Click on dataset cards to select/deselect them
55-
- **Batch Operations**: Select all visible datasets or clear all selections at once
56-
- **Selection Counter**: Always see how many datasets you've selected
57-
- **Shopping Cart**: Your selected datasets appear in a dedicated panel on the right
58-
59-
### 4. Download Management
60-
- **Multi-Source Downloads**: Choose between downloading from ModelScope or HuggingFace
61-
- **Python Commands**: Get ready-to-use Python commands for downloading your selected datasets
62-
- **Clipboard Integration**: Copy download commands with one click
63-
- **Selection Backup**: Export your dataset selections as JSON files for later use
64-
65-
### 5. User-Friendly Interface
66-
- **Loading Progress**: See progress bars while datasets are loading
67-
- **Error Handling**: Clear error messages if something goes wrong
68-
- **Toast Notifications**: Helpful feedback for your actions
69-
- **Keyboard Shortcuts**: Use Ctrl+F to quickly search through filter options
70-
71-
## Getting Started
72-
73-
### Accessing the Web App
74-
1. Visit the live demo: https://flagopen.github.io/RoboCOIN-DataManager/
75-
2. Wait for the datasets to load (you'll see a progress bar)
76-
3. Start exploring the RoboCOIN datasets!
77-
78-
### Browser Compatibility
79-
- **Recommended**: Chrome 61+, Firefox 60+, Safari 11+, Edge 61+
80-
- **JavaScript**: Must be enabled in your browser
81-
- **Internet**: Required for loading dataset information
82-
83-
## How to Use the Web App
84-
85-
### Step 1: Explore Datasets
86-
1. **Browse Videos**: Scroll through the dataset cards to see video previews of robotic tasks
87-
2. **Hover for Info**: Hover over any video card to see basic information without clicking
88-
3. **Click for Details**: Click on a video card to open a detailed modal with complete dataset information
89-
90-
### Step 2: Filter Your Search
91-
1. Click the **"Filter datasets"** button in the top control bar
92-
2. Use the sidebar to choose filter categories:
93-
- **Scene**: Filter by environment (kitchen, living room, etc.)
94-
- **Robot**: Filter by robot model (Franka, UR5, etc.)
95-
- **End-effector**: Filter by gripper type
96-
- **Action**: Filter by task type (pick, place, etc.)
97-
- **Object**: Filter by manipulated objects
98-
3. Click filter options to activate them (you can select multiple)
99-
4. Use the search box (Ctrl+F) to quickly find specific filter options
100-
5. Click **"Done"** or press Escape to apply filters
101-
102-
### Step 3: Search by Name
103-
- Use the search box in the top control bar to search datasets by name
104-
- Search works with your active filters for precise results
105-
- Click the × button to clear your search
106-
107-
### Step 4: Select Datasets
108-
1. **Individual Selection**: Click on video cards to select/deselect them (selected cards show a border and checkmark)
109-
2. **Batch Selection**: Click **"Select all datasets"** to select everything currently visible
110-
3. **Clear Selection**: Click **"Deselect all datasets"** to clear all selections
111-
4. Watch the selection counter in the top bar to see how many you've chosen
112-
113-
### Step 5: Generate Download Commands
114-
1. Your selected datasets appear in the **"Batch Downloader"** panel on the right
115-
2. Choose your preferred download source: **HuggingFace** or **ModelScope**
116-
3. Click **"Copy & Checkout"** to copy the Python download command
117-
4. Paste and run the command in your terminal to download the datasets
118-
5. **Optional**: Add `--target-dir /your/custom/path` to the command for custom download location
119-
120-
### Step 6: Save Your Selections
121-
- **Export Selections**: Click **"Export JSON"** to save your current selections as a file
122-
- **Import Selections**: Click **"Import JSON"** to load previously saved selections
123-
- Useful for sharing selections or continuing work later
124-
125-
### Tips for Best Experience
126-
- **Video Loading**: Videos load automatically when you hover over them
127-
- **Performance**: The app uses virtual scrolling to handle large numbers of datasets efficiently
128-
- **Mobile Friendly**: Works on tablets and phones with touch controls
129-
- **Error Recovery**: If something goes wrong, try refreshing the page
130-
131-
## Need Help or Found an Issue?
132-
133-
### Report Problems
134-
If you encounter any issues while using the web app, please let us know:
135-
- **GitHub Issues**: Visit the [RoboCOIN repository](https://github.com/FlagOpen/RoboCOIN) and create an issue
136-
- **Describe the Problem**: Include what you were doing, what browser you're using, and any error messages
137-
- **Screenshots**: If possible, include screenshots of the issue
138-
139-
### Contact Information
140-
For questions about the RoboCOIN project or datasets:
141-
- **Email**: pykerogers@outlook.com
142-
- **Project Repository**: [github.com/FlagOpen/RoboCOIN](https://github.com/FlagOpen/RoboCOIN)
143-
144-
### About RoboCOIN
145-
This web app is part of the RoboCOIN project. To learn more about the datasets and how to use them in your research:
146-
1. Visit the main RoboCOIN repository
147-
2. Install the Python package: `pip install robocoin`
148-
3. Follow the documentation for dataset usage and citation information
11+
RoboCOIN DataManager is a web app that helps you find and download robotic manipulation datasets from the RoboCOIN project. Instead of digging through complex commands, you can browse videos, filter by tags, pick what you need, and get ready-to-use download commands.
12+
13+
## How to download in one step?
14+
15+
Just click the download icon in the bottom-right corner of any video panel to directly copy the download command!
16+
17+
## How to batch download the data I want?
18+
19+
### Step 1: Open the website
20+
Visit: https://flagopen.github.io/RoboCOIN-DataManager/
21+
22+
Wait for datasets to load (you'll see a progress bar).
23+
24+
### Step 2: Find the data you want
25+
- **Browse videos**: Scroll through the video cards to see what robotic tasks are available
26+
- **Use filters**: Click "Filter datasets" to narrow down by:
27+
- What room/scene (kitchen, living room, etc.)
28+
- What robot (Unitree, Agilex, etc.)
29+
- What action (pick up, place, etc.)
30+
- What objects (cups, boxes, etc.)
31+
- **Search by name**: Use the search box to find specific datasets
32+
33+
### Step 3: Pick your datasets
34+
- Click on video cards to select them, you can select multiple!
35+
- Use "Select all" and "Deselect all" for quick full selection/deselection!
36+
- The counter at the top shows how many datasets you've currently selected
37+
38+
### Step 4: Get download commands
39+
- Look at the "Batch Downloader" panel on the right - all your selected datasets are here!
40+
- Choose your preferred source: HuggingFace or ModelScope
41+
- Click "Copy & Checkout" to copy the Python command
42+
43+
### Step 5: Download the data
44+
1. **First, install RoboCOIN** (one time setup):
45+
```bash
46+
pip install robocoin
47+
```
48+
Pull the corresponding project first: https://github.com/FlagOpen/RoboCOIN
49+
50+
2. **Paste and run the command**:
51+
If needed, you can customize your own download target directory:
52+
```bash
53+
...--target-dir YOUR_TARGET_DOWNLOAD_DIR
54+
```
55+
56+
3. **Wait for download** - RoboCOIN's download tool will handle everything automatically
57+
58+
That's it! Your data will be downloaded to your computer.
59+
60+
## More Features
61+
62+
### Save your selections
63+
- Click "Export JSON" to save your current picks as a file
64+
- Click "Import JSON" to load saved selections later
65+
- Useful for sharing or continuing work later
66+
67+
## Need Help?
68+
69+
### Having trouble downloading?
70+
1. Make sure you installed RoboCOIN: `pip install robocoin`
71+
2. Check your internet connection to GitHub
72+
73+
### Found a bug or have questions?
74+
- **Report issues**: [RoboCOIN GitHub](https://github.com/FlagOpen/RoboCOIN) or create an issue directly in this project
75+
- **Email**: Feel free to contact pykerogers@outlook.com
76+
77+
### Learn more about RoboCOIN
78+
- **Main project**: [github.com/FlagOpen/RoboCOIN](https://github.com/FlagOpen/RoboCOIN)
79+
- **Documentation**: Check the main repo for dataset details and research usage

0 commit comments

Comments
 (0)