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 example describing the structure of the JSON/dict input format for Dataset object #911

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JulioAPeraza
Copy link
Collaborator

@JulioAPeraza JulioAPeraza commented Dec 22, 2024

Add example describing the structure of the JSON/dict input format for Dataset object.

Closes #910.

Summary by Sourcery

Add an example describing the structure of the JSON/dict input format for the Dataset object.

New Features:

  • Add a new example demonstrating how to create a Dataset object from a JSON file.

Documentation:

  • Document the JSON/dict input format for the Dataset object.

@JulioAPeraza JulioAPeraza added the enhancement New feature or request label Dec 22, 2024
Copy link

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.23%. Comparing base (0de67c5) to head (b1d2de6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #911   +/-   ##
=======================================
  Coverage   88.23%   88.23%           
=======================================
  Files          48       48           
  Lines        6382     6382           
=======================================
  Hits         5631     5631           
  Misses        751      751           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JulioAPeraza JulioAPeraza requested a review from jdkent January 6, 2025 19:49
Copy link
Member

@jdkent jdkent left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, this is a good contribution! I just changed the Study/Contrast level->dictionary since that describes the data type used at those levels and makes it consistent with the lower section headings.

# be mapped to five core DataFrames: annotations, coordinates, images, metadata, and texts.

###############################################################################
# Study Level
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Study Level
# Study Dictionary

# }

###############################################################################
# Contrast Level
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Contrast Level
# Contrast Dictionary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for structure of JSON/dict input to Dataset()
2 participants