VoTT 2.0.0图像目标标注工具.zip

# VoTT (Visual Object Tagging Tool) [](https://dev.azure.com/msft-vott/VoTT/_build/latest?definitionId=25&branchName=v2) [](https://codecov.io/gh/Microsoft/VoTT) [](https://sonarcloud.io/dashboard?id=Microsoft_VoTT) [](https://sonarcloud.io/dashboard?id=Microsoft_VoTT) [Current Complexity Analysis Report](https://vottv2.z5.web.core.windows.net/) ## **NOTE:** this is a Preview release of VoTT. Features may be incomplete or behave incorrectly (bugs! 🐞). [Feedback is appreciated!](https://github.com/Microsoft/VoTT/issues) ---------- An open source annotation and labeling tool for image and video assets. VoTT is a React + Redux Web application, written in [TypeScript](https://github.com/Microsoft/TypeScript). This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). Features include: * The ability to label images or video frames * Extensible model for importing data from local or cloud storage providers * Extensible model for exporting labeled data to local or cloud storage providers VoTT helps facilitate an end-to-end machine learning pipeline:  ## Table of Contents <!-- generated using: https://www.npmjs.com/package/markdown-toc--> <!-- command: `markdown-toc -i README.md`--> <!-- toc --> - [VoTT (Visual Object Tagging Tool)](#vott-visual-object-tagging-tool) - [## **NOTE:** this is a Preview release of VoTT. Features may be incomplete or behave incorrectly (bugs! 🐞). Feedback is appreciated!](#note-this-is-a-preview-release-of-vott-features-may-be-incomplete-or-behave-incorrectly-bugs-%F0%9F%90%9E-feedback-is-appreciated) - [Table of Contents](#table-of-contents) - [Getting Started](#getting-started) - [Running VoTT](#running-vott) - [Download and install a release package for your platform (recommended)](#download-and-install-a-release-package-for-your-platform-recommended) - [Build and run from source](#build-and-run-from-source) - [V1 & V2](#v1--v2) - [Where is V1?](#where-is-v1) - [Can I use my V1 projects in V2?](#converting-to-v2) - [Using VoTT](#using-vott) - [Creating Connections](#creating-connections) - [Creating a New Project](#creating-a-new-project) - [Project Settings](#project-settings) - [Security Tokens](#security-tokens) - [Labeling an Image](#labeling-an-image) - [Labeling a Video](#labeling-a-video) - [Exporting Labels](#exporting-labels) - [Collaborators](#collaborators) - [Contributing to VoTT](#contributing-to-vott) <!-- tocstop --> # Getting Started ## Running VoTT VoTT can be installed as a native application or run from source. ### Download and install a release package for your platform (recommended) VoTT is available for Windows, Linux and OSX. Download the appropriate platform package/installer from [GitHub Releases](https://github.com/Microsoft/VoTT/releases). `v2` releases will be prefixed by `2.x`. ### Build and run from source VoTT requires [NodeJS (>= 10.x, Dubnium) and NPM](https://github.com/nodejs/Release) ```bash git clone https://github.com/Microsoft/VoTT.git cd VoTT git checkout v2 npm install npm start ``` **Important:** When running locally with `npm`, both the electron and the browser versions of the application will start. One major difference is that electron can access the local file system. # V1 & V2 VoTT V2 is a refactor and refresh of the original Electron-based application. As the usage and demand for VoTT grew, V2 was started as an initiative to improve and make VoTT more extensible and maintainable. In addition, V2 uses more modern development frameworks and patterns (React, Redux) and is authored in TypeScript. A number of code quality practices have been adopted, including: * Code Linting * Unit tests & mocks (Jest, Enzyme) * [Code coverage](https://codecov.io/gh/Microsoft/VoTT) ([CodeCov.io](https://codecov.io/)) * [Complexity analysis](https://vottv2.z5.web.core.windows.net/) ([Plato](docs/PLATO.md)) All V2 efforts are on the [v2](https://github.com/Microsoft/VoTT/tree/v2) branch. The git history for V1 and V2 have significantly diverged; when V2 is complete, master will be updated to reflect V2. ## Where is V1? Master still reflects The V1 codebase - any fixes or updates can still be made there. Likewise, all 1.x releases can still be found under [GitHub Releases](https://github.com/Microsoft/VoTT/releases). ## Can I use my V1 project in V2? Yes you can! There is support for converting a V1 project into V2 format, but only for V1 projects that have only picture assets. Video assets from V1 are not yet supported. For a smooth experience, it is recommended that you keep your current V1 project (JSON) file in a directory with all your images for that project. When you open the JSON file, you will asked to confirm that you would like to convert your project and then you will be directed to the editor screen. In this process, a `.vott` file will be generated in the same project directory and you can use this as your project file from now on. It is recommended that you back up your V1 project file before converting the project. # Using VoTT ## Creating Connections VoTT is a 'Bring Your Own Data' (BYOD) application. In VoTT, connections are used to configure and manage source (assets to labeled) and target (where labels should be exported to) data sources. Connections can be setup and shared across projects. Connections have been designed using an extensible provider model -- new source/target provides can easily be added. Currently, VOTT supports: * Azure Blob Storage * [Bing Image Search](https://azure.microsoft.com/en-us/services/cognitive-services/bing-image-search-api/) * Local File System To create a new connection, click the 'New Connection' icon, in the left hand navigation bar:  ## Creating a New Project Labeling workflows in VoTT revolve around projects - a collection of configuration and settings that are persisted. Projects define a source and target connection, as well as project metadata - including tags to be used when labeling source assests. As mentioned above, all projects require a source and target connection: * **Source Connection** - Where to pull assests from * **Target Connection** - Where project files and exported data are stored  ### Project Settings Project settings can be modified after a project has been created, by clicking on the 'Project Setting' icon in the left hand navigation bar. #### Security Tokens Some project settings can include sensitive values, such as API keys or other shared secrets. Each project will generate a security token that can be used to encrypt/decrypt sensitive project settings. Security tokens can be found under 'Application Settings' by clicking the gear icon in the lower corner of the left hand navigation bar. **NOTE:** Project files can be shared among multiple people. In order to share sensitive project settings, *all parties must have/use the same security token.* The token name and key *must* match in order for sensitive values to be successfully decrypted.  ## Labeling an Image When a project is created or opened, the main tag editor window opens. The tag editor consists of two main parts: * A preview pane that contains a scrollable list of images and videos, from the source target * The main editor tool that allows tags to be applied to dra