You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kirill Lakhov 912e47e56c
Added special description to built-in models (#5682)
<!-- Raise an issue to propose your change
(https://github.com/opencv/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution
guide](https://opencv.github.io/cvat/docs/contributing/). -->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [ ] I submit my changes into the `develop` branch
- [ ] I have added a description of my changes into the
[CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md)
file
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))

### License

- [ ] I submit _my code changes_ under the same [MIT License](
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.
3 years ago
..
dist React, Antd, Redux: Left sidebar and top for annotation page (#963) 6 years ago
src Added special description to built-in models (#5682) 3 years ago
.dockerignore User interface with React and antd (#785) 6 years ago
.env Fixed Intel license headers (#119) 4 years ago
.eslintignore Projects (#2255) 5 years ago
.eslintrc.js Typescripted cvat-core, cvat-data (#120) 4 years ago
README.md fix: docs url (#4877) 4 years ago
index.d.ts Fix ESlint problems / typescript for cvat-core (#5027) 3 years ago
package.json Remove limit on maximum number of manifest files that can be added for cloud storage (#5660) 3 years ago
react_nginx.conf Don't cache index.html (#4277) 4 years ago
tsconfig.json New authentication UI (#5181) 3 years ago
webpack.config.js Debug health check (#5587) 3 years ago

README.md

cvat-ui module

Description

This is a client UI for Computer Vision Annotation Tool based on React, Redux and Antd

Versioning

If you make changes in this package, please do following:

  • After not important changes (typos, bug fixes, refactoring) do: yarn version --patch
  • After adding new features do: yarn version --minor
  • After significant UI redesign do: yarn version --major

Important: If you have changed versions for cvat-core, cvat-canvas, cvat-data, you also need to do yarn install to update package-lock.json

Commands

  • Installing dependencies:
cd ../cvat-core && yarn --frozen-lockfile && cd - && yarn --frozen-lockfile
  • Running development UI server with autorebuild on change
yarn run start
  • Building the module from sources in the dist directory:
yarn run build
yarn run build --mode=development     # without a minification

Important: You also have to run CVAT REST API server (please read https://opencv.github.io/cvat/docs/contributing/) to correct working since UI gets all necessary data (tasks, users, annotations) from there