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

Create and Upload the Workflow Diagram #39

Open
AhmedFatthy1040 opened this issue Dec 2, 2024 · 0 comments
Open

Create and Upload the Workflow Diagram #39

AhmedFatthy1040 opened this issue Dec 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority-medium For medium-priority issues.

Comments

@AhmedFatthy1040
Copy link
Owner

Create and Upload the Workflow Diagram

Description

Design a workflow diagram that visually represents the flow of data and interactions between the components of the project, including:

  • User interactions with the frontend.
  • Backend processing for image upload, dataset handling, and annotation management.
  • AI service integration for generating automatic annotations.
  • Manual annotation tools and export functionality.

The diagram will be added to the project documentation.


Tasks

  1. Design the Diagram:
    • Use a tool like Lucidchart, Draw.io, or Mermaid.js.
    • Include the following components:
      • Frontend: Image upload, annotation display, dataset management.
      • Backend: API endpoints for datasets, images, and annotations.
      • AI Service: YOLOv5 integration for object detection.
      • Database: Storage for datasets, images, and annotations.
    • Illustrate workflows:
      • Dataset upload.
      • Manual and automatic annotation.
      • Annotation export.
  2. Export the Diagram:
    • Save the diagram in PNG format.
    • Optionally, export a PDF version for documentation.
  3. Upload the Diagram:
    • Add the PNG file to the project repository under the docs/ folder.
    • Update the README or any relevant documentation to include the diagram.

Acceptance Criteria

  • The workflow diagram is clear and visually appealing.
  • The diagram includes all key components and workflows.
  • The PNG file is uploaded to the docs/ folder in the repository.
  • The README or relevant documentation references the diagram.
@AhmedFatthy1040 AhmedFatthy1040 added documentation Improvements or additions to documentation good first issue Good for newcomers priority-medium For medium-priority issues. labels Dec 2, 2024
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 good first issue Good for newcomers priority-medium For medium-priority issues.
Projects
None yet
Development

No branches or pull requests

2 participants