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

Enhance docs #37

Merged
merged 10 commits into from
Oct 9, 2024
Merged

Enhance docs #37

merged 10 commits into from
Oct 9, 2024

Conversation

mbsantiago
Copy link
Owner

This PR significantly enhances the Whombat user guide by adding two sections:

  • Data Import Guide:
    Provides clear, step-by-step instructions on how to import data into Whombat.
    Guides users through importing the example data, allowing them to quickly get started and explore Whombat's capabilities.

  • Data Export Guide:
    Explains how to export data from Whombat.
    Includes a practical example demonstrating how to use exported data for developing machine learning detectors. This example covers fundamental data wrangling steps, making it easy for users to apply the process to their own projects.

These additions make the user guide more comprehensive and provide valuable resources for users who want to import and export data effectively and leverage Whombat for machine learning development.

Copy link

codecov bot commented Oct 9, 2024

Codecov Report

Attention: Patch coverage is 96.85535% with 10 lines in your changes missing coverage. Please review.

Project coverage is 66.46%. Comparing base (ce5ea11) to head (43d7998).
Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
back/src/whombat/system/boot.py 60.00% 4 Missing ⚠️
...ack/src/whombat/api/io/aoef/annotation_projects.py 80.00% 3 Missing ⚠️
back/src/whombat/routes/annotation_projects.py 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #37      +/-   ##
==========================================
+ Coverage   60.69%   66.46%   +5.77%     
==========================================
  Files         179      179              
  Lines        8093     8365     +272     
==========================================
+ Hits         4912     5560     +648     
+ Misses       3181     2805     -376     

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

@mbsantiago mbsantiago merged commit 7fa94d6 into main Oct 9, 2024
8 checks passed
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.

1 participant