Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rbonghi committed Dec 18, 2024
1 parent 478a856 commit 43f9846
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
Binary file modified docs/images/pages/06-jtop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/pages/06B-jtop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 13 additions & 2 deletions docs/jtop/jtop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ In this page the GPU status. A detailed documentation of this output is availabl
- name GPU
- Load percentage
- Governor GPU
#. **GPU Shared RAM** Status Shared GPU. (In grey the used memory)
#. **GPU Shared RAM** Status Shared GPU. (In grey the total used memory)
#. **Flags** GPU Flags
- **3D Scaling** You can enable and disable the 3D scaling on your board
- **Railgate**
Expand Down Expand Up @@ -283,9 +283,20 @@ This page allow you to control your device, starting from :py:attr:`jtop.jtop.fa
#. You can select the fan profile available on your board, more details in :py:attr:`jtop.jtop.fan`
#. It is a real time chart with the current fan speed
#. You can enable/disable :py:attr:`jtop.jtop.jetson_clocks` and set on boot (Note: jetson_clocks start only after 60s from up time)
#. You can select which NVPmodel you want to use on your board. Where you see the letter "D" means is the default configuration.
#. You can select which NVPmodel you want to use on your board. Where you see the letter "D" means is the default configuration. If the mode is colored in Amber, it means that to apply need to reboot the board.
#. A detailed table with Power, Volt and Current of your board. There is also teh Warning and Critical current before the board fail. More info :py:attr:`jtop.jtop.power`

.. image:: /images/pages/06B-jtop.png
:align: center

If you press a mode that need a reboot you will see a dialog message like this

#. You can chosse between **[Force and reboot]** or **[Skip]** the operation

.. danger::

If you click on **[Force and reboot]** the board will be rebooted immediately without any warning.

Controls
""""""""

Expand Down
4 changes: 4 additions & 0 deletions jtop/core/nvpmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,10 @@ def set_nvpmodel_id(self, nvpmodel_id, force=False):
"""
Set a new NVP model by ID. The list of nvpmodel available is with :py:func:`~get_all_nvpmodels` or :py:attr:`~models`.
.. danger::
If you set force=True the board will be rebooted immediately without any warning.
.. code-block:: python
with jtop() as jetson:
Expand Down

0 comments on commit 43f9846

Please sign in to comment.