Skip to content

Commit e9aa12a

Browse files
committed
Several tweaks.
1 parent f5debf7 commit e9aa12a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/src/tutorials/basic_julia_workflow.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
#
33
# This short tutorial introduces the minimal workflow for people working
44
# purely in Julia. There are (or are in development) separate tutorials
5-
# on using ACEpotentials via shell scripts or via Python, and tutorials
5+
# on using `ACEpotentials` via shell scripts or via Python, and tutorials
66
# on more advanced usage.
77
#
8-
# Start by importing ACEpotentials (and possibly other required libraries)
8+
# Start by importing `ACEpotentials` (and possibly other required libraries)
99

1010
using ACEpotentials
1111

@@ -15,7 +15,7 @@ using ACEpotentials
1515
# data_file = "path/to/TiAl_tutorial.xyz"
1616
# data = read_extxyz(data_file)
1717
# ```
18-
# For convenience we provide this dataset as a [Julia artifact](https://docs.julialang.org/en/v1/stdlib/Artifacts/) and make it conveniently accessible via `ACEpotentials.example_dataset`. We keep only a small subset of the structures for training and testing to keep the regression problem small.
18+
# For convenience we provide this dataset as a [Julia artifact](https://docs.julialang.org/en/v1/stdlib/Artifacts/) and make it accessible via `ACEpotentials.example_dataset`. We keep only a small subset of the structures for training and testing to keep the regression problem small.
1919

2020
data, _, meta = ACEpotentials.example_dataset("TiAl_tutorial")
2121
train_data = data[1:5:end];
@@ -80,7 +80,7 @@ open("TiAl_model.json", "w") do f
8080
JSON.print(f, Dict("hyperparams" => hyperparams, "params" => model.ps))
8181
end
8282

83-
# To load the model back from disk it is safest to work within the same Julia project, i.e. the same version of all packages; ideally the the Manifest should ot be changed. One then generates the model again, loads the parameters from disk and then sets them in the model. Again, this will be automated in the future.
83+
# To load the model back from disk it is safest to work within the same Julia project, i.e. the same version of all packages; ideally the the Manifest should not be changed. One then generates the model again, loads the parameters from disk and then sets them in the model. Again, this will be automated in the future.
8484

85-
# cleaning up ...
86-
rm("TiAl_model.json")
85+
# Finally, we delete the model to clean up.
86+
rm("TiAl_model.json")

0 commit comments

Comments
 (0)