rapidsai / rapidsai/deployment

Enhance docs pages with debugging/profiling guides

Open
#637 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
15
Forks
41
Avg merge
1d 8h
Merged PRs (30d)
6

Description

All of our deployment pages cover install and smoke tests, but nothing beyond that. A common question we get is how to debug our work in these environments.

We should compile a list of common debugging tasks, such as executing Python with nsys and retrieving the profile to view locally in NSight.

We should then go through each deployment page and add instructions on how to do these tasks. In VMs this will likely be easy as we control everything in the stack. In managed notebook environments it may be harder to debug as we don't control the startup commands. These environments are the places where this kind of information is even more valuable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the deployment pages and their existing install and smoke-test sections first. Inventory common debugging tasks, including running Python with nsys and retrieving profiles for local viewing in NSight, then add applicable instructions to each deployment page. Done means every deployment environment has usable debugging and profiling guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.