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

MCS-1991 Cleaned Up Documentation and Added Task List Page #714

Merged
merged 12 commits into from
Dec 15, 2023

Conversation

ThomasSchellenbergNextCentury
Copy link
Collaborator

@ThomasSchellenbergNextCentury ThomasSchellenbergNextCentury commented Dec 13, 2023

  • Cleaned up our docs (run make html from the docs/ folder to recreate the pages locally)
  • Removed outdated scene files from the github repo
  • Created a "task list" page with information about all the evaluation tasks (mostly copied from the "task list" and "eval plan" pages on Confluence)

Link to the "task list" page: https://github.com/NextCenturyCorporation/MCS/blob/MCS-1991/TASK_LIST.md

Comment on lines -154 to -161
timeout
^^^^^^^

(int, optional)

If the amount of time between steps exceeds the amount specified (represented in seconds), throw and error and attempt to end scene (default: 3600 (or 1 hour)).


Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was already listed in install.rst

Comment on lines -124 to +125
only_return_goal_object
^^^^^^^^^^^^^^^
controller_timeout
^^^^^^^^^^^^^^^^^^
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These just got alphabetized

Comment on lines -26 to +28
$ sudo nvidia-xconfig --use-display-device=None --virtual=600x400 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
# Your virtual display size should be much larger than the MCS Unity window size (default 600x400)
$ sudo nvidia-xconfig --use-display-device=None --virtual=1200x800 --output-xconfig=/etc/X11/xorg.conf --busid=PCI:0:30:0
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the virtual display size, and added a comment

Comment on lines -9 to -14
Eval 5 Example Interactive Scenes
*********************************

Relevant for the Summer 2022 evaluation (Eval 5):

:download:`holes_eval_5_ex_1.json <./scenes/holes_eval_5_ex_1.json>`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed information and examples from this page about specific evaluation tasks, because they're now described in the "task list" page (a lot of the information was outdated anyway).

:download:`tool_use_eval_5_ex_3.json <./scenes/tool_use_eval_5_ex_3.json>`

:download:`tool_use_eval_5_ex_4.json <./scenes/tool_use_eval_5_ex_4.json>`
For more example interactive scenes, please see our `task list <https://github.com/NextCenturyCorporation/MCS/blob/development/TASK_LIST.md>`_ page.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the link won't work until this PR is merged.

@@ -12,7 +12,6 @@ Machine Common Sense Documentation
api
scenes
schema
training
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this outdated page about training for the NYU tasks (updated information is in the new "task list" page anyway).

@ThomasSchellenbergNextCentury ThomasSchellenbergNextCentury requested review from rartiss55, phile-caci and NDCACI and removed request for rartiss55 December 13, 2023 14:43
@phile-caci phile-caci merged commit 6a0d8d4 into development Dec 15, 2023
8 checks passed
@phile-caci phile-caci deleted the MCS-1991 branch December 15, 2023 17:02
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