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 written documentation for the ctc error types with example graphs #178

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

msschwartz21
Copy link
Collaborator

@msschwartz21 msschwartz21 commented Dec 19, 2024

Check the read the docs preview for the new page

Types of Changes

What types of changes does your code introduce? Delete those that do not apply.

  • Documentation update

Which topics does your change affect? Delete those that do not apply.

  • Track Errors

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the developer/contributing docs.
  • I have added tests that prove that my feature works in various situations or tests the bugfix (if appropriate).
  • I have checked that I maintained or improved code coverage.
  • I have checked the benchmarking action to verify that my changes did not adversely affect performance.
  • I have written docstrings and checked that they render correctly in the Read The Docs build (created after the PR is opened).
  • I have updated the general documentation including Metric descriptions and example notebooks if necessary.

@msschwartz21 msschwartz21 added the documentation Improvements or additions to documentation label Dec 19, 2024
Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.15%. Comparing base (2ce238f) to head (939cbe8).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #178   +/-   ##
=======================================
  Coverage   93.15%   93.15%           
=======================================
  Files          19       19           
  Lines         877      877           
=======================================
  Hits          817      817           
  Misses         60       60           

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for track errors nodes and edges
1 participant