Skip to content

Commit

Permalink
changed readme (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
@johncalesp
johncalesp authored Mar 31, 2023
1 parent ce2544e commit a233855
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/0001287428a20bef03ad/maintainability)](https://codeclimate.com/github/CentML/DeepView.Explore/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/0001287428a20bef03ad/test_coverage)](https://codeclimate.com/github/CentML/DeepView.Explore/test_coverage)

# VSCode Plugin for ML Tools
# VSCode Plugin for DeepView

![Demo GIF](https://raw.githubusercontent.com/CentML/mltools-vscode/jun07-usability-improvements/images/demo.gif)

## Documentation
https://docs.centml.ai/index.html

## Installation
Installation consists of two parts: the front-end UI (this repository) and [Skyline](https://github.com/CentML/skyline) (the backend), which needs to be installed separately.
Installation consists of two parts: the front-end UI (this repository) and [DeepView.Profile](https://github.com/CentML/DeepView.Profile) (the backend), which needs to be installed separately.

### Frontend Installation
To install, either:
Expand All @@ -29,7 +29,7 @@ To install, either:
Once you have the vsix file, run `code --install-extension vscode*.vsix` to install the extension.
**Note: the file [build_vsix_dev.sh] is only to be used for development**

**Adding cloud instances to the Deployment Tab:** You can include information about the instances that you use thrugh the extension settings. There you will find an option named **providers** that accepts a list of urls separated by commas. Each url must be a JSON file that follows the schema specified here : [schema](skyline-vscode/react-ui/src/schema/CloudProvidersSchema.js).<br/>
**Adding cloud instances to the Deployment Tab:** You can include information about the instances that you use through the extension settings. There you will find an option named **providers** that accepts a list of urls separated by commas. Each url must be a JSON file that follows the schema specified here : [schema](skyline-vscode/react-ui/src/schema/CloudProvidersSchema.js).<br/>
Additionally, you need to add the necessary access so the extension can read the file.<br/>
You can use an AWS S3 bucket to store your files. Change CORS settings in Permissions tab.

Expand Down Expand Up @@ -59,18 +59,18 @@ This is our [file](https://deepview-explorer-public.s3.amazonaws.com/vscode-clou
### Backend Installation
This plugin requires Skyline (the installation instruction for which can be found [here](https://github.com/CentML/skyline)) and (optionally) Habitat (used to extrapolate GPU runtimes, instructions found [here](https://github.com/CentML/habitat)). **Skyline must be launched before running this extension.**
This plugin requires DeepView.Profile (the installation instruction for which can be found [here](https://github.com/CentML/DeepView.Profile)) and (optionally) DeepView.Predict (used to extrapolate GPU runtimes, instructions found [here](https://github.com/CentML/DeepView.Predict)). **DeepView.Profile must be launched before running this extension.**
After installation, please make note of the path to the `skyline` binary. To do so, run `which skyline` after ensuring that the `skyline` binary works. This path is different depending on how the backend was installed. Default installation from PyPI will place the binary to `/usr/bin/skyline`, however if you're running the backend in virtual environment it will be in a different location. **You need to launch `skyline` before running this extension.**
After installation, please make note of the path to the `DeepView.Profile` binary. To do so, run `which skyline` after ensuring that the `DeepView.Profile` binary works. This path is different depending on how the backend was installed. Default installation from PyPI will place the binary to `/usr/bin/skyline`, however if you're running the backend in virtual environment it will be in a different location. **You need to launch `DeepView.Profile` before running this extension.**
## Usage example
1. Open one of the examples DNN project examples, i.e. [Resnet](https://github.com/CentML/skyline/tree/main/examples/resnet) from Skyline in VSCode
2. (Optional) You can add other external cloud instances. Use the CloudProvidersSchema.yaml file as a reference. This file is located under the schemas folder. Once you have created your own yaml file, you can reference the path to this file in the extension settings in **providers** option. The file will be read when the extension is called.
1. Open one of the examples DNN project examples, i.e. [Resnet](https://github.com/CentML/skyline/tree/main/examples/resnet) from DeepView.Profile in VSCode
2. (Optional) You can add other external cloud instances using the **providers** option in the extension
3. Press `Ctrl+Shift+P`, then select `Skyline` from the dropdown list.
3. Click on `Begin Analysis`.
## Disabling telemetry
If you do not want to send usage data to CentML, you can set the skyline.isTelemetryEnabled setting to "No".
If you do not want to send usage data to CentML, you can set isTelemetryEnabled setting to "No".
You can set the value by going to File > Preferences > Settings (On macOS: Code > Preferences > Settings), and search for telemetry. Then set the value in Skyline > Is Telemetry Enabled. This will disable all telemetry events.
Expand All @@ -79,7 +79,7 @@ As well, DeepView respects VSCode's telemetry levels. IF telemetry.telemetryLeve
## Development Environment Setup
### Dependencies
1. https://github.com/CentML/skyline
1. https://github.com/CentML/DeepView.Profile
- Note: depending on you choose to install the backend you might need to set the backend path.
2. [Node.js](https://nodejs.org/en/) and npm
Expand All @@ -91,13 +91,13 @@ apt install protobuf-compiler
### Setup
1. Clone this repository:
```zsh
git clone https://github.com/CentML/skyline-vscode
git clone https://github.com/CentML/DeepView.Explore
```
1. Install project dependencies
```zsh
cd skyline-vscode/react-ui && npm install --legacy-peer-deps
cd skyline-vscode/react-ui && npm install
cd ../..
cd skyline-vscode/skyline-vscode && npm install --legacy-peer-deps
cd skyline-vscode/skyline-vscode && npm install
```
1. Compile protobuf files:
```zsh
Expand All @@ -110,7 +110,7 @@ Start VSCode in the plugin source directory:
cd skyline-vscode/skyline-vscode;
code .
```
Press `F5` to compile and run the extension. When the extension window appears, open of the [example projects](https://github.com/CentML/skyline/tree/main/examples). Then press `Ctrl-Shift-P` then select `Begin Analysis`.
Press `F5` to compile and run the extension. When the extension window appears, open of the [example projects](https://github.com/CentML/DeepView.Profile/tree/main/examples). Then press `Ctrl-Shift-P` then select `Begin Analysis`.

To debug the React UI without extension code, set `const sendMock = true;` in the `react-ui/App.js`, then start the project as any other React.app.

Expand All @@ -126,10 +126,10 @@ To debug the React UI without extension code, set `const sendMock = true;` in th
* Upload the VSIX file to S3

## Release history
See [Releases](https://github.com/CentML/mltools-vscode/releases).
See [Releases](https://github.com/CentML/DeepView.Explore/releases).

## Meta
See [Skyline](https://github.com/CentML/skyline).
See [DeepView.Profile](https://github.com/CentML/DeepView.Profile).

## Contributing
- Guidelines on how to contribute to the project

0 comments on commit a233855

Please sign in to comment.