-
Notifications
You must be signed in to change notification settings - Fork 629
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.
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
Provide instructions on virtualenv. #258
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,11 +62,13 @@ Histogram can be used to visualize parameter distribution and trends for any ten | |
</p> | ||
|
||
## Quick Start | ||
To give the VisualDL a quick test, please use the following commands. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So instead of this, why don't we just give them a simple command "virtualenv venv; source venv/bin/activate`. This requires them to go read another doc and figure out how virtualenv works. What do you think? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah just saw your stuff for contrib. I'd just add those lines here too and avoid the confusiuon. |
||
|
||
``` | ||
# install | ||
# Install the VisualDL. Preferably under a virtual environment. | ||
pip install --upgrade visualdl | ||
|
||
# run a demo | ||
# run a demo, vdl_scratch.py will create logs for testing. | ||
vdl_scratch.py | ||
visualDL --logdir=scratch_log --port=8080 | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,6 +27,22 @@ VisualDL 目前使用[Git流分支模型](http://nvie.com/posts/a-successful-git | |
```bash | ||
git checkout -b my-cool-stuff | ||
``` | ||
1. Virtualenv | ||
|
||
virtualenv是一个独立的Python虚拟环境。我们强烈建议您使用` virtualenv `来保持你的Python环境清洁。 | ||
要创建虚拟环境并激活它,请使用以下命令。 | ||
|
||
```bash | ||
pip install --upgrade virtualenv | ||
virtualenv YOUR_VIRTUAL_EVN_FOLDER | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes yes yes!! |
||
source YOUR_VIRTUAL_EVN_FOLDER/bin/activate | ||
``` | ||
|
||
完成此工作后,可以通过操作来解除虚拟环境。 | ||
```bash | ||
deactivate | ||
``` | ||
要了解更多关于` virtualenv `,点击[这里](https://virtualenv.pypa.io/en/stable/) | ||
|
||
1. commit | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
运行一个例子?