Annotations

[elijahbenizzy]

Adds annotations workflow. See #285.

High-level:

1. You can annotate an action
2. This can be associated with a number of "observations", each one on a piece of data
3. You can add notes/ground truths/thumbs up/thumbs down on these
4. There is a project-level view (meant to be a queue) that you can work on
5. You can download these into a CSV.

Changes

• BE -- added endpoints to create, expose
• FE -- added annotations view to app
• FE -- added annotations by project
• Edit + create modals to both

How I tested this

• manually

Notes

Remaining:

• Ensure this doesn't break the S3 implementation
• Add docs + appropriate references

Checklist

• PR has an informative and human-readable title (this will be pulled into the release notes)
• Changes are limited to a single goal (no scope creep)
• Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future TODOs are captured in comments
• Project documentation has been updated if adding/changing functionality.

---

Important

Add comprehensive annotations workflow with backend endpoints and frontend views for creating, updating, and managing annotations.

• Backend:
  • Add AnnotationsBackendMixin to backend.py for handling annotations.
  • New endpoints in run.py for creating, updating, and retrieving annotations.
• Frontend:
  • Add AnnotationsViewContainer and AnnotationsView in AppView.tsx for displaying annotations.
  • Add Drawer component in drawer.tsx for annotation editing.
  • Update ProjectList.tsx to include annotations link.
• API:
  • Add models AnnotationCreate, AnnotationUpdate, AnnotationOut, AnnotationObservation, and AnnotationDataPointer.
  • Update DefaultService.ts with new annotation-related API calls.
• Misc:
  • Update package.json dependencies for new features.
  • Add Chip component updates in chip.tsx for annotation tags.

^{This description was created by for bcd21d7. It will automatically update as commits are pushed.}

[github-actions]

A preview of bcd21d7 is uploaded and can be seen here:

✨ https://burr.dagworks.io/pull/383 ✨

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/383/

[elijahbenizzy]

TODO, will add more:

• skip loading of annotations if BE does not support it
• Fix up so it works with spans
  • Add in UI
  • Ensure it's in data model
• Wire through to BE
  • create
  • get
  • update
• Ergonomics
  • Restrict to a single annotation per (sequence_id, span_id) on the BE
  • Add form-validation for create
  • Add different tags for colors
  • Search bar based on tags
• Test on S3/implement

[elijahbenizzy]

Annotations view with inline app

Annotations edit/create window:

Inline annotation edit modal

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to bcd21d7 in 59 seconds

More details

• Looked at 3020 lines of code in 25 files
• Skipped 1 files when reviewing.
• Skipped posting 2 drafted comments based on config settings.

1. telemetry/ui/src/components/routes/app/AppView.tsx:191

• Draft comment:
  Consider simplifying the logic for setting the current action index by consolidating the logic for 'forceCurrentActionIndex' and 'disableNavigateSteps'. This will make the code cleaner and reduce duplication.
• Reason this comment was not posted:
  Confidence changes required: 50%
  The code in AppView.tsx has a potential issue with the use of the 'forceCurrentActionIndex' prop. The logic to set the current action index is duplicated and could be simplified.

2. telemetry/ui/src/examples/MiniTelemetry.tsx:22

• Draft comment:
  Consider removing the check against the string 'null' for the 'partitionKey' prop if it's already typed as 'string | null'. This can simplify the code and prevent potential errors.
• Reason this comment was not posted:
  Confidence changes required: 30%
  In the MiniTelemetry.tsx file, the 'partitionKey' prop is checked against the string 'null', which might not be necessary if the prop is already typed as 'string | null'.

Workflow ID: wflow_TSM3mfjJbSGkk8Mv

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[skrawcz]

this looks good for a v1