Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

[VS Code] changelog and readme #2429

Merged
merged 3 commits into from
Mar 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion contrib/pai_vscode/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.0.1] - 2018-01-09
## [0.1.0] - 2019-01
### Added
- Open job pages and dashboard pages in VS Code
- Submit job to PAI cluster from VS Code
- Open PAI's hdfs as a workspace folder

## [0.2.0] - 2019-03
### Added
- Generate jsonc job config by default
- Add a PAI view container (sidebar), includes
- Job list view
- Auto refresh enabled
- HDFS explorer
- You can choose where hdfs explorer will be shown (view container or workspace folder)
21 changes: 20 additions & 1 deletion contrib/pai_vscode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ The extension has a useful feature called "Simulate Job Running". It enables the

![](https://raw.githubusercontent.com/Microsoft/pai/master/contrib/pai_vscode/assets/simulate-job.gif)

## Sidebar
Copy link
Member

Choose a reason for hiding this comment

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

来个截图吧

HDFS Explorer and Job List view will be shown in the extension's view container (sidebar).

### HDFS Explorer
1. You are able to connect to an OpenPAI cluster's HDFS by double click its corresponding tree node.
2. The HDFS directory structure will be expended in the tree view.
3. Right click the folder or file node to perform file system operations.

### Job List
1. Browse latest jobs in the OpenPAI cluster in job list tree view.
2. Browse recent submitted jobs by local (extension) in job list tree view.
3. Job list will auto refresh every 10 seconds.
4. Double click job node to browse Job details in external browser.

![](https://raw.githubusercontent.com/Microsoft/pai/master/contrib/pai_vscode/assets/job-list.png)

## Commands
### Command Pallete
Expand All @@ -61,7 +76,7 @@ The extension has a useful feature called "Simulate Job Running". It enables the
|Submit Job...|Submit job to selected cluster|
|Simulate Job Running...|Generate Dockerfile to simulate PAI job running|
|Edit Configuration...|Edit cluster configuration|
|Open HDFS...|Open selected cluster's HDFS as a VS Code workspace folder|
|Open HDFS...|Open HDFS explorer of selected cluster|

## Settings
|ID|Description|
Expand All @@ -70,6 +85,10 @@ The extension has a useful feature called "Simulate Job Running". It enables the
|pai.job.upload.exclude|Glob pattern for excluding files and folders|
|pai.job.upload.include|Glob pattern for including files and folders|
|pai.job.generateJobName.enabled|Controls whether the extension will add a random suffix to your job name when submitting job|
|pai.job.jobList.recentJobsLength|Controls the number of recently submitted jobs to keep in history for each PAI cluster|
|pai.job.jobList.allJobsPageSize|Controls the page size of list when listing jobs for each PAI cluster|
|pai.job.jobList.refreshInterval|Controls the refresh interval of job list (in seconds)|
|pai.hdfs.location|Location where hdfs explorer will be shown|

## Requirements
PAI Cluster Version >= 0.8.0
Expand Down
Binary file added contrib/pai_vscode/assets/job-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.