-
Notifications
You must be signed in to change notification settings - Fork 204
Inference documentation improvements #1421
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
base: main
Are you sure you want to change the base?
Conversation
I like the changes so far, @capjamesg lmk when done |
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
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.
first link on getting started page goes to non exitent page
docs/start/getting-started.md
Outdated
|
||
# load a pre-trained yolov8n model | ||
model = get_model(model_id="yolov8n-640") | ||
Before you get started, make sure you have [installed Inference](/install/start/). |
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.
this link 404s
I pushed a commit to fix the links to the install / setup page and add the download buttons to it. I also updated the redirect on the /download page that is used from the app to go to the setup page. I'm a bit worried we might have to go through and check all of the links though. At least there seems to be a ton of relative links that don't work. Like all the links that are just |
@capjamesg , I only noticed, can you sign your commits? |
@capjamesg are these still desired updates? the merge conflicts are blocking I think |
Description
This PR contains several improvements to the Inference documentation.
The philosophy for this change maps to our strategy to be Workflows-first. Running a model should be a one-block Workflow. Users should be able to build complex, multi-stage Workflows as easily as possible.
The following changes have been made:
Type of change
How has this change been tested, please provide a testcase or example of how you tested the change?
This change can be tested by running
mkdocs serve
and clicking around.Any specific deployment considerations
We need to set a
GHOST_API_KEY
constant in our Actions secrets so the docs build can pull the latest posts from the Roboflow blog that have been marked as tutorials.Docs
N/A