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

REST API /api/jobs/<id>/commits #4368

Merged
merged 8 commits into from
Feb 26, 2022
Merged

REST API /api/jobs/<id>/commits #4368

merged 8 commits into from
Feb 26, 2022

Conversation

nmanovic
Copy link
Contributor

@nmanovic nmanovic commented Feb 20, 2022

Motivation and context

Now it is possible to run GET /api/jobs/<id>/commits method to list all commits for a job. Each commit has scope field which describes an action which was done by the user. Now create and update scopes are supported. In the future it is possible to add annotate scope. But for simplicity the scope was not implemented in the PR (it was necessary to change dataset manager to pass the owner field). The scope field can be used for filtration in the future. Another important field is data in JSON format. It contains new fields for the commit.

When we implement annotate scope it will be possible to draw nice figures in UI (the data annotation process over the time). Possible format for the commit see below.

{
  "owner": {"id": 1, "username": "admin"},
  "scope": "annotate",
  {
    "created": 100,
    "updated": 20,
    "deleted": 0
}

Also the commit can have additional details about labels, attributes, shapes, tracks:

{
  "owner": {"id": 1, "username": "admin"},
  "scope": "annotate",
  {
    "created": [
      {"label": "person", "shape": null, "num_frames": 1 },
      {"label": "car", "shape": "rect", "num_frames": 100 },
    ],
    "updated": 20,
    "deleted": 0
}

How has this been tested?

Manually

Checklist

  • I submit my changes into the develop branch
  • I have added a description of my changes into CHANGELOG file

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2022 Intel Corporation
#
# SPDX-License-Identifier: MIT

@nmanovic nmanovic changed the title [WIP] REST API /api/jobs/<id>/commits REST API /api/jobs/<id>/commits Feb 20, 2022
@nmanovic
Copy link
Contributor Author

@Marishka17 , @bsekachev , could you please look?

@nmanovic nmanovic merged commit e8f294f into develop Feb 26, 2022
@nmanovic nmanovic deleted the nm/job_commit branch February 26, 2022 18:15
@nmanovic nmanovic mentioned this pull request Mar 4, 2022
7 tasks
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