Skip to content

Commit 400b9c1

Browse files
committed
Expand on model definition bit in README
1 parent b51e3a6 commit 400b9c1

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,12 @@ You can modify the list of AD types in `main.jl`.
1414

1515
You can modify the list of models in `models.jl`.
1616

17-
Note that if you want the model definition to be shown on the website, your model definitions must be of the form `@model function name() ... end`.
18-
One-liner function definitions like `@model f(x) = ...`will not work.
17+
Note that if you want the model definition to be shown on the website, your model definitions must be of the 'standard' form `@model function name() ... end`.
18+
This means that:
19+
- One-liner function definitions like `@model f(x) = ...`will not work.
20+
- Fancy metaprogramming tricks to generate a family of models at one go (like [this](https://github.com/TuringLang/ADTests/blob/266d7ab85fea2e01e7e05af6cee179d7f6200b0f/models.jl#L108-L129)) will not work.
21+
22+
To understand why, see the `get_model_definition` function in `ad.py`.
1923

2024
## I want to edit the website!
2125

0 commit comments

Comments
 (0)