Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alihussainia authored Nov 4, 2020
1 parent 6e27410 commit 58cddeb
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,44 @@ Open Source OpenVINO Edge developement and deployment on Google Colab using Col

## USAGE STEPS:

### Step 1:Package installation on Google Colab. [Ref: Demp.ipynb](https://github.com/alihussainia/openvino-colab/blob/master/demo.ipynb)
### Step 1: Package installation on Google Colab. [Ref: Demo.ipynb](https://github.com/alihussainia/openvino-colab/blob/master/demo.ipynb)
Run the command in the first cell of your Google Colab to install the `openvino-colab` package.

```python3
!pip install openvino-colab
```
### Step 2:Importing openvino-colab into your notebook [Ref: Demp.ipynb](https://github.com/alihussainia/openvino-colab/blob/master/demo.ipynb)
### Step 2: Importing openvino-colab into your notebook [Ref: Demo.ipynb](https://github.com/alihussainia/openvino-colab/blob/master/demo.ipynb)
Run the below command in a new cell to install the OpenVINO toolkit in Google Colab.

```python3
import openvino_colab
```
### Step 3 (Optional): Importing server function into your notebook [Ref: Demo.ipynb](https://github.com/alihussainia/openvino-colab/blob/master/demo.ipynb)

```python3
from openvino_colab import server
```
### Step 4 : Calling server function

```python3
server()
```
Server Function can take these optional arguments:

- port = `enter port no.` - the port you want to run server on, default 10000

- password = `enter password` - password to protect your server.

- mount_drive = `enter True or False` - to mount your drive.

- example of syntax: `server(port=10000, password='ali', mount_drive=True)`

### Tip for running server: (Optional but Recommended)
To Enable `Copy/Paste` in server terminals:

- Use Chrome Browser

- visit <a target=blank>chrome://settings/content/clipboard</a> and add your xyz.ngork.io link there.

## REFERENCES:

Expand All @@ -32,4 +57,4 @@ import openvino_colab
[https://docs.openvinotoolkit.org/2019_R1/_vehicle_attributes_recognition_barrier_0039_description_vehicle_attributes_recognition_barrier_0039.html]

### colabcode package
[https://github.com/abhishekkrthakur/colabcode]
[https://github.com/abhishekkrthakur/colabcode]

0 comments on commit 58cddeb

Please sign in to comment.