Skip to content

Commit

Permalink
Minor improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fjwillemsen committed May 15, 2024
1 parent 45db8a4 commit a42731a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 3 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Contributing
------------
If you're looking to contribute to this package: welcome!
Please check the open `issues <https://github.com/AutoTuningAssociation/autotuning_methodology/issues>`_ and `pull requests <https://github.com/AutoTuningAssociation/autotuning_methodology/pulls>`_ to avoid duplicate work.

Setup
^^^^^
Expand All @@ -21,5 +22,6 @@ When referrring to functions and parameters in the docstring outside of their de

Testing
^^^^^^^
Before contributing a pull request, please run ``nox`` and ensure it has no errors. This will test against all Python versions explicitely supported by this package, and will check whether the correct formatting has been applied.
Before contributing a pull request, please run ``nox`` and ensure it has no errors.
This will test against all Python versions explicitely supported by this package, and will check whether the correct formatting has been applied.
Upon submitting a pull request or pushing to main, these same checks will be ran remotely via GitHub Actions.
4 changes: 0 additions & 4 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Python 3.9 and up are supported.

Defining an experiment
^^^^^^^^^^^^^^^^^^^^^^

To get started, all you need is an experiments file.
This is a `json` file that describes the details of your comparison: which algorithms to use, which programs to tune on which devices, the graphs to output and so on.
A simple example experiments file is as follows:
Expand All @@ -18,7 +17,6 @@ A simple example experiments file is as follows:

Running experiments
^^^^^^^^^^^^^^^^^^^

To use these experiment files, two entry points are defined: ``autotuning_experiment`` and ``autotuning_visualize``.
Both entrypoints take one argument: the path to the experiments file.
The first runs the experiment and saves the results, the second visualizes the results.
Expand All @@ -28,15 +26,13 @@ If the results do not yet exists, ``autotuning_visualize`` will automatically tr

A note on file references
^^^^^^^^^^^^^^^^^^^^^^^^^

File references in experiments files are relative to the location of the experiment file itself.
File references in tuning scripts are relative to the location of the tuning script itself. Tuning scripts need to have the global literals `file_path_results` and `file_path_metadata` for this package to know where to get the results.
Plots outputted by this package are placed in a folder called `generated_plots` relative to the current working directory.


Processing Pipeline
^^^^^^^^^^^^^^^^^^^

To clarify the complex process of this package to obtain the results and visualize, the flowcharts below illustrate this pipeline.

.. image:: source/flowchart_performance_curve_generation.png
Expand Down

0 comments on commit a42731a

Please sign in to comment.