Skip to content

Commit 1fed143

Browse files
committed
update
1 parent 50dc256 commit 1fed143

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/setup.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ To get started with ``hls4ml``, we provide some default example models for conve
6666
# This will download our example model to your working directory and return an example configuration file
6767
config = hls4ml.utils.fetch_example_model('KERAS_3layer.json')
6868
69-
print(config) #You can print it to see some default parameters
69+
# You can print it to see some default parameters
70+
print(config)
7071
7172
# Convert it to a hls project
7273
hls_model = hls4ml.converters.keras_to_hls(config)
@@ -85,7 +86,7 @@ After that, you can use :code:`Vivado HLS` to synthesize the model:
8586
# Print out the report if you want
8687
hls4ml.report.read_vivado_report('my-hls-test')
8788
88-
Done! You've built your first project using ``hls4ml`` ! To learn more about our various API functionalities, check out our tutorials `here <https://github.com/fastmachinelearning/hls4ml-tutorial>`__.
89+
Done! You've built your first project using ``hls4ml``! To learn more about our various API functionalities, check out our tutorials `here <https://github.com/fastmachinelearning/hls4ml-tutorial>`__.
8990

9091
If you want to configure your model further, check out our :doc:`Configuration <api/configuration>` page.
9192

@@ -100,15 +101,15 @@ To follow this tutorial, you must first download our ``example-models`` reposito
100101
101102
git clone https://github.com/fastmachinelearning/example-models
102103
103-
The model files, along with other configuration parameters, are defined in the ``.yml`` files.
104-
Further information about ``.yml`` files can be found in :doc:`Configuration <api/configuration>` page.
105-
106104
Alternatively, you can clone the ``hls4ml`` repository with submodules
107105

108106
.. code-block:: bash
109107
110108
git clone --recurse-submodules https://github.com/fastmachinelearning/hls4ml
111109
110+
The model files, along with other configuration parameters, are defined in the ``.yml`` files.
111+
Further information about ``.yml`` files can be found in :doc:`Configuration <api/configuration>` page.
112+
112113
In order to create an example HLS project:
113114

114115

@@ -179,4 +180,4 @@ Existing examples
179180
Examples of model files and weights can be found in `example_models <https://github.com/fastmachinelearning/example-models>`_ directory.
180181

181182
*
182-
Training codes and examples of resources needed to train the models can be found `in the tutorial <https://github.com/fastmachinelearning/keras-training>`__.
183+
Training codes and examples of resources needed to train the models can be found in the `tutorial <https://github.com/fastmachinelearning/hls4ml-tutorial>`__.

0 commit comments

Comments
 (0)