Skip to content

Commit

Permalink
Update README.md and planning_doc.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KeplerC committed Apr 8, 2024
1 parent ee768b1 commit 5211db5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
[![codecov](https://codecov.io/gh/KeplerC/fog_rtx/branch/main/graph/badge.svg?token=fog_rtx_token_here)](https://codecov.io/gh/KeplerC/fog_rtx)
[![CI](https://github.com/KeplerC/fog_rtx/actions/workflows/main.yml/badge.svg)](https://github.com/KeplerC/fog_rtx/actions/workflows/main.yml)

🦊Fog-X: An Efficient and Scalable Data Collection and Management Framework For Robotics Learning. Support Open-X-Embodiment, HuggingFace.
🦊Fog-X: An Efficient and Scalable Data Collection and Management Framework For Robotics Learning. Support [Open-X-Embodiment](https://robotics-transformer-x.github.io/), [HuggingFace](https://huggingface.co/)🤗.

🦊Fog-X considers memory efficiency and speed by working with a trajectory-level metadata and a lazily-loaded dataset. Implemented on [Apache Pyarrows](https://arrow.apache.org/docs/python/index.html) dataset, it allows flexible partitioning of the dataset on distributed storage.
🦊Fog-X considers both speed🚀 and memory efficiency📈 with active metadata and lazily-loaded trajectory data. 🦊 supports flexible and distributed partitioning of the dataset.

## Install

```bash
pip install fog_rtx
pip install fogx
```

## Usage

```py
import fog_rtx as fox
import fogx as fox

# 🦊 Dataset Creation
# from distributed dataset storage
Expand Down
6 changes: 4 additions & 2 deletions design_doc/planning_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
### Big Steps
1. asynchonous writing, test with multiple processes & episodes
2. querying language and pulling optimization
3. time sync join policy
3. time sync join policy (FPS-based)
5. handling streaming with a builder pattern (?)
7. ROS / ROS2
8. recompaction to save space
8. recompaction to save space
9. CLI
10. hugging face

0 comments on commit 5211db5

Please sign in to comment.