Skip to content

Commit

Permalink
Merge pull request #7 from octo-models/readme_update
Browse files Browse the repository at this point in the history 
update README with pytorch example
  • Loading branch information
@kpertsch
kpertsch authored Dec 14, 2023
2 parents f990ad7 + 7a84562 commit 6fb4e11
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,14 @@ At the moment we provide the following model versions:
We provide simple [example scripts](examples) that demonstrate how to use and finetune Octo models,
as well as how to use our data loader independently. We provide the following examples:

| | |
|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| [Octo Inference](examples/01_inference_pretrained.ipynb) | Minimal example for loading and running a pretrained Octo model |
| [Octo Finetuning](examples/02_finetune_new_observation_action.py) | Minimal example for finetuning a pretrained Octo models on a small dataset with a new observation and action space |
| [Octo Rollout](examples/03_eval_finetuned.py) | Run a rollout of a pretrained Octo policy in a Gym environment |
| [Octo Robot Eval](examples/04_eval_finetuned_on_robot.py) | Evaluate a pretrained Octo model on a real WidowX robot |
| [OpenX Dataloader Intro](examples/05_dataloading.ipynb) | Walkthrough of the features of our Open X-Embodiment data loader |
| | |
|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| [Octo Inference](examples/01_inference_pretrained.ipynb) | Minimal example for loading and running a pretrained Octo model |
| [Octo Finetuning](examples/02_finetune_new_observation_action.py) | Minimal example for finetuning a pretrained Octo models on a small dataset with a new observation and action space |
| [Octo Rollout](examples/03_eval_finetuned.py) | Run a rollout of a pretrained Octo policy in a Gym environment |
| [Octo Robot Eval](examples/04_eval_finetuned_on_robot.py) | Evaluate a pretrained Octo model on a real WidowX robot |
| [OpenX Dataloader Intro](examples/05_dataloading.ipynb) | Walkthrough of the features of our Open X-Embodiment data loader |
| [OpenX PyTorch Dataloader](examples/06_pytorch_oxe_dataloader.ipynb) | Standalone Open X-Embodiment data loader in PyTorch |


## Octo Pretraining
Expand Down
15 changes: 8 additions & 7 deletions examples/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
We provide simple [example scripts](examples) that demonstrate how to inference and finetune OCTO models,
as well as how to use our data loader independently. We provide the following examples:

| | |
|-------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| [OCTO Inference](examples/01_inference_pretrained.ipynb) | Minimal example for loading and inferencing a pre-trained OCTO model |
| [OCTO Finetuning](examples/02_finetune_new_observation_action.py) | Minimal example for finetuning a pre-trained OCTO models on a small dataset with new observation + action space |
| [OCTO Rollout](examples/03_eval_finetuned.py) | Run a rollout of a pre-trained OCTO policy in a Gym environment |
| [OCTO Robot Eval](examples/04_eval_finetuned_on_robot.py) | Evaluate a pre-trained OCTO model on a real WidowX robot |
| [OpenX Dataloader Intro](examples/05_dataloading.ipynb) | Walkthrough of the features of our Open X-Embodiment data loader
| | |
|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| [OCTO Inference](examples/01_inference_pretrained.ipynb) | Minimal example for loading and inferencing a pre-trained OCTO model |
| [OCTO Finetuning](examples/02_finetune_new_observation_action.py) | Minimal example for finetuning a pre-trained OCTO models on a small dataset with new observation + action space |
| [OCTO Rollout](examples/03_eval_finetuned.py) | Run a rollout of a pre-trained OCTO policy in a Gym environment |
| [OCTO Robot Eval](examples/04_eval_finetuned_on_robot.py) | Evaluate a pre-trained OCTO model on a real WidowX robot |
| [OpenX Dataloader Intro](examples/05_dataloading.ipynb) | Walkthrough of the features of our Open X-Embodiment data loader |
| [OpenX PyTorch Dataloader](examples/06_pytorch_oxe_dataloader.ipynb) | Standalone Open X-Embodiment data loader in PyTorch |

0 comments on commit 6fb4e11

Please sign in to comment.