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.

Sign up for GitHub

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

Jump to bottom

[docs] SceneDataset JSON #1863

Merged
merged 2 commits into from
Sep 13, 2022
Merged

[docs] SceneDataset JSON #1863

merged 2 commits into from
Sep 13, 2022

Conversation

aclegg3
Copy link
Contributor

@aclegg3 aclegg3 commented Sep 13, 2022 •
edited

Motivation and Context

Added improved documentation for SceneDataset JSON and Attributes.

Added docstrings for python Attributes, AttributeManager, and MetadataMediator modules/classes for improved clarity.

Primary doc topics:

  • SceneDataset and .scene_dataset_config.json tags
  • Scene instances and .scene_instance.json tags
  • User Defined metadata options ("user_defined")
    • including .ao_config.json files

How Has This Been Tested

Locally built the docs to test.

New Overview diagram and description:
image

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • [x ] I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Sep 13, 2022
@Skylion007
Copy link
Contributor

Nit: can the diagram be a vector graphic (such as SVG?)

jturner65
jturner65 approved these changes Sep 13, 2022
View reviewed changes
Copy link
Contributor

@jturner65 jturner65 left a comment

Choose a reason for hiding this comment

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

LGTM!

@aclegg3 aclegg3 merged commit 8cbc120 into main Sep 13, 2022
@aclegg3 aclegg3 deleted the scene-dataset-docs branch September 13, 2022 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jturner65 jturner65 jturner65 approved these changes

@Skylion007 Skylion007 Skylion007 approved these changes

@dhruvbatra dhruvbatra Awaiting requested review from dhruvbatra

@eundersander eundersander Awaiting requested review from eundersander

@ykarmesh ykarmesh Awaiting requested review from ykarmesh

Assignees
No one assigned
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@aclegg3 @Skylion007 @jturner65 @facebook-github-bot