Skip to content

Commit

Permalink
Merge pull request #100 from BerkeleyLab/update-readme
Browse files Browse the repository at this point in the history
doc(README): clarify language
  • Loading branch information
rouson authored Nov 26, 2023
2 parents 79d6257 + b303e37 commit 9673024
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Project is up to date
}
}
```
As of this writing, the JSON file format is fragile. Because an Intel `ifx` compiler bug prevents using our preferred JSON interface, [rojff], Inference-Engine currently use a very restricted but valid JSON subset that can be read and written by type-bound procedures on the `string_t` type in the [sourcery] utility. For this to work, it is important to keep input files as close as possible to the exact form shown above. In particular, do not split, combine or otherwise significantly rearrange lines in the above format other than adding or removing whitespace if so desired.
As of this writing, the JSON file format is fragile. Because an Intel `ifx` compiler bug prevents using our preferred JSON interface, [rojff], Inference-Engine currently uses a very restricted JSON subset written and read by the [sourcery] utility's `string_t` type-bound procedures. For this to work, it is important to keep input files as close as possible to the exact form shown above. In particular, do not split, combine or reorder lines. Adding or removing whitespace should be ok.

Documentation
-------------
Expand Down
2 changes: 1 addition & 1 deletion ford.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
project: Inference-Engine
summary: A deep learning library targetingo high-performance computing (HPC) applications with performance-critical inference and training needs.
summary: A deep learning library targeting high-performance computing (HPC) applications with performance-critical inference and training needs.
src_dir: src/
src_dir: example
exclude_dir: doc
Expand Down

0 comments on commit 9673024

Please sign in to comment.