Skip to content
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

Dev/rst doc qa #445

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Dev/rst doc qa #445

wants to merge 3 commits into from

Conversation

cameron-a-johnson
Copy link
Collaborator

No description provided.

@@ -0,0 +1,79 @@
Running Angel System with Speech QA
======================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For RST files, these section demoninators are going to want to be the same character length as the section title. This will be a warning that is output by a Sphinx build. This comment applies to various sections below this.

Comment on lines 41 to 45
Running the Server
----------------------

Create conda environment
----------------------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was it intended for the "Create conda environment" section to be a child of "Running the Server"? If so, I recommend following the section "tiering" documentation here. Following that documentation, this section should use ^ characters.


.. code-block:: bash

export CUDA_VISIBLE_DEVICES=4; python speech_server.py
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theoretically, this should be equivalent to running CUDA_VISIBLE_DEVICES=4 python speech_server.py, but if what you have works, it works.

@Purg
Copy link
Member

Purg commented Jun 18, 2024

See comments above still, if this was not already on your plate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants