This release is a pre-release and may not be stable for production use.
🦊 Fog-RT-X
🦊 Fog-RT-X: An Efficient and Scalable Data Collection and Management Framework For Robotics Learning. Support Open-X-Embodiment, 🤗HuggingFace.
🦊 Fog-RT-X considers both speed 🚀 and memory efficiency 📈 with active metadata and lazily-loaded trajectory data. It supports flexible and distributed dataset partitioning. It provides native support to cloud storage.
Design Doc | Dataset Visualization
Install
pip install fog_x
Usage
import fog_x
# 🦊 Dataset Creation
# from distributed dataset storage
dataset = fog_x.Dataset(
name="demo_ds",
path="~/test_dataset", # can be AWS S3, Google Bucket!
)
# 🦊 Data collection:
# create a new trajectory
episode = dataset.new_episode()
# collect step data for the episode
episode.add(feature = "arm_view", value = "image1.jpg")
# Automatically time-aligns and saves the trajectory
episode.close()
# 🦊 Data Loading:
# load from existing RT-X/Open-X datasets
dataset.load_rtx_episodes(
name="berkeley_autolab_ur5",
additional_metadata={"collector": "User 2"}
)
# 🦊 Data Management and Analytics:
# Compute and memory efficient filter, map, aggregate, groupby
episode_info = dataset.get_episode_info()
desired_episodes = episode_info.filter(episode_info["collector"] == "User 2")
# 🦊 Data Sharing and Usage:
# Export and share the dataset as standard Open-X-Embodiment format
# it also supports hugging face, and more!
dataset.export(desired_episodes, format="rtx")
# Load with pytorch dataloader
torch.utils.data.DataLoader(dataset.as_pytorch_dataset(desired_episodes))
Design
🦊 Fog-RT-X recognizes most post-processing, analytics and management involves the trajectory-level data, such as tags, while actual trajectory steps are rarely read, written and transformed. Acessing and modifying trajectory data is very expensive and hard.
As a result, 🦊 Fog-RT-X proposes
- a user-friendly metadata table via Pandas Datframe for speed and freedom
- a LazyFrame from Polars for the trajectory dataset that only loads and transform the data if needed
- parquet as storage format for distributed storage and columnar support compared to tensorflow records
- Easy and automatic RT-X/Open-X dataset export and pytorch dataloading
More Coming Soon!
Currently we see a more than 60% space saving on some existing RT-X datasets. This can be even more by re-paritioning the dataset. Our next steps can be found in the planning doc. Feedback welcome through issues or PR to planning doc!
We also note we are at a beta-testing phase. We make our best effort to be backward-compatible but interfaces may be unstable.
Development
Read the CONTRIBUTING.md file.
Metadata
Release files for fog-x 0.1.0b4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fog_x-0.1.0b4.tar.gz | 35.1 kB | Without provenance | Details for fog_x-0.1.0b4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fog_x-0.1.0b4-py3-none-any.whl | Python 3 | none | any | Details for fog_x-0.1.0b4-py3-none-any.whl |
Total release size: 70.6 kB
Release files / fog_x-0.1.0b4.tar.gz
| Download URL | fog_x-0.1.0b4.tar.gz |
|---|---|
| Size | 35.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b8bab1691a9591bd06e48b740ce9a027cc1c57b14e646f8f06bf032869cd5867
|
|
BLAKE2b-256 checksum How to use checksums |
4c1c72c10652f5e17035d2ef158b9ac44e572a1aa31b61425ea72214996e8c66
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.12
|
Release files / fog_x-0.1.0b4-py3-none-any.whl
| Download URL | fog_x-0.1.0b4-py3-none-any.whl |
|---|---|
| Size | 35.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
65b024b32be2d6af89745bc766cb9d564cff3c5fd1c4c875a4270444198fb30b
|
|
BLAKE2b-256 checksum How to use checksums |
7acf413720fc7c06263d4684ac1343cd52b4ac3f70d9fd9192022fdf67636ae7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.12
|
Security for fog-x 0.1.0b4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.