docs: add quick start section for beginners#1074
Open
sumedhaagh wants to merge 2 commits intofossasia:masterfrom
Open
docs: add quick start section for beginners#1074sumedhaagh wants to merge 2 commits intofossasia:masterfrom
sumedhaagh wants to merge 2 commits intofossasia:masterfrom
Conversation
Added a Quick Start section in README to help new users quickly install and run Visdom locally.
Contributor
Reviewer's GuideAdds a new 'Quick Start' section to the README that provides a minimal step-by-step guide for installing Visdom, starting the server, accessing the dashboard in a browser, and running a simple Python example. Flow diagram for Quick Start steps to run Visdom locallyflowchart TD
A[Read Quick Start section in README] --> B[Install Visdom using pip install visdom]
B --> C[Start Visdom server using visdom]
C --> D[Open browser and navigate to http://localhost:8097]
D --> E[Create and run Python script using visdom.Visdom]
E --> F[View text and scatter plot in Visdom dashboard]
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider mentioning any minimum Python/pip version or environment assumptions in the Quick Start (e.g., that
piprefers to the same interpreter you’ll run Visdom with) to avoid confusion for new users. - You might want to show the server start command with an explicit port and host (e.g.,
visdom -port 8097 -host 0.0.0.0) and note thathttp://localhost:8097is the default URL, so users know how to customize it if needed.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider mentioning any minimum Python/pip version or environment assumptions in the Quick Start (e.g., that `pip` refers to the same interpreter you’ll run Visdom with) to avoid confusion for new users.
- You might want to show the server start command with an explicit port and host (e.g., `visdom -port 8097 -host 0.0.0.0`) and note that `http://localhost:8097` is the default URL, so users know how to customize it if needed.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Author
|
Thanks for the feedback! I've updated the Quick Start section to clarify that |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a Quick Start section in README to help new users quickly install and run Visdom locally.
Description
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist:
py/visdom/VERSIONaccording to Semantic VersioningSummary by Sourcery
Documentation: