This repository has been archived by the owner on Jun 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 548
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refine homepage for new users (#2155)
Updated first level bullets, to add more content for administrators and users, who is first time touch OpenPAI, or computing platform.
- Loading branch information
1 parent
953d655
commit 4294699
Showing
9 changed files
with
174 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# OpenPAI VS Code Client | ||
|
||
## Installation | ||
|
||
Visual Studio Code is a free, lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. Go to [Visual Studio Code Official Site](https://code.visualstudio.com/) to install and learn more. | ||
|
||
OpenPAI Client is a VS Code extension to connect PAI clusters, submit AI jobs, and manage files on HDFS, etc. You need to install the extension in VS code before using it. | ||
|
||
To install the OpenPAI Client: | ||
|
||
1. Launch VS Code. | ||
2. Click the "Extensions" icon in Activity Bar or press **Ctrl+Shift+X** to bring up the Extensions view. | ||
3. Input **openpai** in the text box, the OpenPAI VS Code Client will appear in the result list. | ||
4. Click the **Install** button. The extension will be installed. | ||
5. After a successful installation, you will see an introduction page. Follow the instructions there and try the PAI client. | ||
|
||
![Extension](./assets/ext-install-1.png) | ||
|
||
## Next step | ||
|
||
Learn how to [use OpenPAI VS Code Client](./README.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,32 @@ | ||
## How to ask a question on Stack Overflow about OpenPAI | ||
# Search or ask questions on Stack Overflow about OpenPAI | ||
|
||
### 1. Click the "Ask Question" button. | ||
Navigate to the Stack Overflow homepage in your browser at stackoverflow.com. In the upper right hand corner of the page, you should see the Ask Question button, which you should click to continue. | ||
## Search existing questions | ||
|
||
![PAI_ask_question1](./images/PAI_ask_question1.PNG) | ||
We recommend searching before asking. In case someone met the similar problem, it may save your time. [click here](https://stackoverflow.com/questions/tagged/openpai) to find related questions. | ||
|
||
### 2. Read the disclaimer. | ||
Then check the box box indicating you have read and understand the disclaimer and click "Proceed." Now you're ready to ask your question! | ||
## Ask a question about OpenPAI | ||
|
||
![PAI_ask_question2](./images/PAI_ask_question2.PNG) | ||
1. Click [the link](https://stackoverflow.com/questions/ask?tags=openpai) with 'openpai' tag. | ||
|
||
### 3. Fill in the necessary information. | ||
This is where your problem description and title come in handy. Fill in the information and take a moment to double check spelling and grammar. That last thing you want is someone hassling your usage instead of answering your question. Then click on "Post your question." | ||
You need to sign up at first use. Go ahead, Stack Overflow is a trustworthy web site. Or you can ask question on [github](https://github.com/Microsoft/pai/issues/new/choose) directly. | ||
|
||
![PAI_ask_question3](./images/PAI_ask_question3.PNG) | ||
1. Read the advice and proceed. | ||
|
||
### 4. Add any relevant tags. | ||
In the tags field, when you begin typing, the Stack Overflow system will automatically suggest likely tags to help you with this process. Be sure you read the descriptions for your tags. An incorrect tag can seriously limit potential responses. | ||
You can read advice or search related topic again. If you still want to post a new question, choose the checkbox below, and click 'proceed'. | ||
|
||
![PAI_ask_question4](./images/PAI_ask_question4.PNG) | ||
![PAI_ask_question2](./images/PAI_ask_question2.PNG) | ||
|
||
1. Ask the question, then click on "Post Your question" | ||
|
||
## How to search OpenPAI related questions | ||
OpenPAI's stackoverflow tag: openpai. User could view questions and ask questions under this tag. | ||
- [StackOverflow: tag openpai](https://stackoverflow.com/questions/tagged/openpai) | ||
![PAI_ask_question3](./images/PAI_ask_question3.PNG) | ||
|
||
1. Add any relevant tags. | ||
|
||
In the tags field, when you begin typing, the Stack Overflow system will automatically suggest likely tags to help you with this process. We already choose 'opanpai' tag for you. | ||
|
||
![PAI_ask_question4](./images/PAI_ask_question4.PNG) | ||
|
||
Referenece: | ||
- https://stackoverflow.com/help/how-to-ask | ||
- https://www.wikihow.com/Ask-a-Question-on-Stack-Overflow | ||
|
||
* [How do I ask a good question?](https://stackoverflow.com/help/how-to-ask) | ||
* [How to Ask a Question on Stack Overflow](https://www.wikihow.com/Ask-a-Question-on-Stack-Overflow) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters