Skip to content

[JOSS review]: Fix bullet and link rendering in README #271

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.

Sign up for GitHub

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

Merged
ktras merged 2 commits into from
Aug 29, 2025
Merged

[JOSS review]: Fix bullet and link rendering in README #271

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3ed4ec
Fix bullet rendering in README
joewallwork Aug 22, 2025
44961f4
Fix links to code in repo
joewallwork Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,17 @@ Towards these ends,
To broaden support for the native parallel features, the Fiats contributors also write compiler tests, bug reports, and patches; develop a parallel runtime library ([Caffeine]); participate in the language standardization process; and provide example inference and training code for exercising and evaluating compilers' automatic parallelization capabilities on processors and accelerators, including Graphics Processing Units (GPUs).

Available optimizers:

* Stochastic gradient descent and
* Adam (recommended).

Supported network types:

* Feed-forward networks and
* Residual networks (for inference only).

Supported activation functions:

* Sigmoid,
* RELU,
* GELU,
Expand Down Expand Up @@ -196,17 +199,17 @@ Documentation
Please see our [GitHub Pages site] for Hypertext Markup Languge (HTML) documentation generated by [`ford`] or generate documentation locally by installing `ford` and executing `ford ford.md`.

### UML
Please see the `doc/uml` subdirectory for Unified Modeling Language (UML) diagrams such as a comprehensive Fiats [class diagram] with human-readable [Mermaid] source that renders graphically when opened by browsing to the document on GitHub.
Please see the [`doc/uml`](https://github.com/BerkeleyLab/fiats/blob/main/doc/uml) subdirectory for Unified Modeling Language (UML) diagrams such as a comprehensive Fiats [class diagram] with human-readable [Mermaid] source that renders graphically when opened by browsing to the document on GitHub.

[Building and testing]: #building-and-testing
[Caffeine]: https://go.lbl.gov/caffeine
[class diagram]: ./doc/uml/class-diagram.md
[class diagram]: https://github.com/BerkeleyLab/fiats/blob/main/doc/uml/class-diagram.md
[Documentation]: #documentation
[demo]: demo
[demo]: https://github.com/BerkeleyLab/fiats/blob/main/demo
[E3SM]: https://e3sm.org
[example]: example
[example/print-training-configuration.F90]: example/print-training-configuration.F90
[example/concurrent-inferences]: example/concurrent-inferences.f90
[example]: https://github.com/BerkeleyLab/fiats/blob/main/example
[example/print-training-configuration.F90]: https://github.com/BerkeleyLab/fiats/blob/main/example/print-training-configuration.F90
[example/concurrent-inferences]: https://github.com/BerkeleyLab/fiats/blob/main/example/concurrent-inferences.f90
[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford
[`fpm`]: https://github.com/fortran-lang/fpm
[Getting Started]: #getting-started
Expand All @@ -222,4 +225,4 @@ Please see the `doc/uml` subdirectory for Unified Modeling Language (UML) diagra
[Overview]: #overview
[ROCm fork]: https://github.com/ROCm/llvm-project
[rojff]: https://gitlab.com/everythingfunctional/rojff
[saturated_mixing_ratio_m]: example/supporting-modules/saturated_mixing_ratio_m.f90
[saturated_mixing_ratio_m]: https://github.com/BerkeleyLab/fiats/blob/main/example/supporting-modules/saturated_mixing_ratio_m.f90