Skip to content
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.

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

add FAQ to readme #30

Merged
merged 2 commits into from
Jan 8, 2024
Merged

add FAQ to readme #30

merged 2 commits into from
Jan 8, 2024

Conversation

mees
Copy link
Collaborator

@mees mees commented Jan 7, 2024

Adds a FAQ to the Readme exaplining pad_mask, pad_mask_dict etc.

@HomerW
Copy link
Collaborator

HomerW commented Jan 7, 2024

Thanks Oier!

  • We should mention that the HistoryWrapper will take care of adding the pad_mask key for you.
  • We could potentially put this in the evaluation README instead. That README should probably be more descriptive anyway.

@ceramic-sf
Copy link

The additions to the FAQ look good.

A diagram such as the following could also be helpful:

---
title: Historical window size and action chunking
---
flowchart TD
    subgraph history[history windows, `window_size=2`]
        obs_m_1[observation m - 1]
        obs_m[observation m]
    end

    octo
    obs_m_1 & obs_m --> octo

    subgraph action[action chunking, 'pred_horizon=4']

        act_n[action n]
        act_n_1[action n + 1]
        act_n_2[action n + 2]
        act_n_3[action n + 3]
    end
    octo --> act_n & act_n_1 & act_n_2 & act_n_3
Loading

@mees mees merged commit 8fe7497 into main Jan 8, 2024
1 check passed
@mees mees deleted the add_faq branch January 8, 2024 18:21
WenchangGaoT pushed a commit to WenchangGaoT/octo1 that referenced this pull request May 10, 2024
Add jax utils, change train.py to use in/out shardings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants