Skip to content

Commit 2675fb9

Browse files
Doc update
1 parent 92ad1d2 commit 2675fb9

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/source/guide/faqs.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,13 @@ Frequently Asked Questions
99
What unit is ... specified in?
1010
------------------------------
1111
We use un-prefixed units for all values. Joules, seconds, meters, square meters, bits,
12-
etc.
12+
etc. If you're working internally in the code, you may see reservations as well; these
13+
are a porportion of maximum, from 0 to 1.
14+
15+
In what order are area, energy, latency, and leak power parameters and names?
16+
-----------------------------------------------------------------------------
17+
Wherever applicable, we follow alphabetical order of area, energy, latency, and leak
18+
power. For example, the main function for calculating these attributes is
19+
:py:meth:`~accelforge.frontend.spec.Spec.calculate_component_area_energy_latency_leak`.
20+
The same convention is followed in `hwcomponents
21+
<https://github.com/accelergy-project/hwcomponents>`_.

docs/source/guide/guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ Support
161161
If you encounter issues or have questions:
162162

163163
- Check the :doc:`faqs` page
164-
- Review example files in the ``examples/`` directory
164+
- Review `the AccelForge tutorials <https://github.com/Accelergy-Project/accelforge/tree/main/notebooks/tutorials>`_
165+
- Review `the AccelForge examples <https://github.com/Accelergy-Project/accelforge/tree/main/examples>`_
165166
- Browse the `source code on GitHub <https://github.com/Accelergy-Project/accelforge>`_
166167
- Open an issue on `GitHub <https://github.com/Accelergy-Project/accelforge>`_
167168

0 commit comments

Comments
 (0)