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.

Sign up for GitHub

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

Jump to bottom

improved documentation for component 'Semi-automatic and automatic an… #2273

Closed
wants to merge 1 commit into from
Closed

improved documentation for component 'Semi-automatic and automatic an… #2273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions cvat/apps/documentation/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,24 @@ docker-compose -f docker-compose.yml -f components/analytics/docker-compose.anal
```

### Semi-automatic and automatic annotation
- First of all, you need to build and run the container with [serverless support for CVAT](/components/serverless/README.md):

- You have to install `nuctl` command line tool to build and deploy serverless
```bash
# From project root directory
docker-compose -f docker-compose.yml -f components/serverless/docker-compose.serverless.yml up -d
```

- You also have to install `nuctl` command line tool to build and deploy serverless
functions. Download [the latest release](https://github.com/nuclio/nuclio/releases).
For example, for Ubuntu you can download the binary file `nuctl-1.4.18-linux-amd64`.
Put it in the CVAT root directory and change its permission to be executable.

- [Run Nuclio dashboard with](https://github.com/nuclio/nuclio)

```bash
docker run -p 8070:8070 -v /var/run/docker.sock:/var/run/docker.sock -v /tmp:/tmp --name nuclio-dashboard quay.io/nuclio/dashboard:stable-amd64
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's unnecessary step, it's already configured here https://github.com/openvinotoolkit/cvat/blob/develop/components/serverless/docker-compose.serverless.yml#L4-L20

```

- Create `cvat` project inside nuclio dashboard where you will deploy new
serverless functions and deploy a couple of DL models. Commands below should
be run only after CVAT has been installed using docker-compose because it
Expand All @@ -307,7 +322,10 @@ nuctl deploy --project-name cvat \
--platform local
```

Note: see [deploy.sh](/serverless/deploy.sh) script for more examples.
Note:
- see [deploy.sh](/serverless/deploy.sh) script for more examples.
- As an example, if you use `nuctl-1.4.18-linux-amd64` in the CVAT root directory,
you need to change the `nuctl` in the above commands to `.nuctl-1.4.18-linux-amd64`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
you need to change the `nuctl` in the above commands to `.nuctl-1.4.18-linux-amd64`.
you need to change the `nuctl` in the above commands to `nuctl-1.4.18-linux-amd64`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably a better approach is to rename nuclt-* to nuctl or make a soft link ln nuctl-1.4.18-linux-amd64 nuctl


### Stop all containers

Expand Down