Skip to content
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.

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

Add transformation information to --info #1462

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 39 additions & 6 deletions src/frontend/Info.ml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
open Yojson.Basic

let rec unsized_basetype_json t =
let to_json (type_, dim) : t =
`Assoc [("type", `String type_); ("dimensions", `Int dim)] in
let to_json (type_, dim) =
[("type", `String type_); ("dimensions", `Int dim)] in
let internal, dims = UnsizedType.unwind_array_type t in
match internal with
| UnsizedType.UInt -> to_json ("int", dims)
Expand All @@ -16,23 +16,56 @@
| UMatrix -> to_json ("real", dims + 2)
| UComplexMatrix -> to_json ("complex", dims + 2)
| UTuple internals ->
`Assoc
[ ("type", `List (List.map ~f:unsized_basetype_json internals))
; ("dimensions", `Int dims) ]
[ ( "type"
, `List
(List.map ~f:(fun t -> `Assoc (unsized_basetype_json t)) internals)
); ("dimensions", `Int dims) ]
| UMathLibraryFunction | UFun _ | UArray _ -> assert false

let basetype_dims t = SizedType.to_unsized t |> unsized_basetype_json

let rec transformation t =
let expr_string = Fmt.to_to_string Pretty_printing.pp_expression in
let expr_string e =
`String (expr_string (Ast.untyped_expression_of_typed_expression e)) in
let transform details = [("constraint", details)] in
match t with
| Transformation.Identity -> transform (`String "none")
| Lower e -> transform @@ `Assoc [("lower", expr_string e)]
| Upper e -> transform @@ `Assoc [("upper", expr_string e)]
| LowerUpper (e1, e2) ->
transform @@ `Assoc [("lower", expr_string e1); ("upper", expr_string e2)]
| Offset e -> transform @@ `Assoc [("offset", expr_string e)]
| Multiplier e -> transform @@ `Assoc [("multiplier", expr_string e)]
| OffsetMultiplier (e1, e2) ->

Check warning on line 40 in src/frontend/Info.ml

View check run for this annotation

Codecov / codecov/patch

src/frontend/Info.ml#L35-L40

Added lines #L35 - L40 were not covered by tests
transform
@@ `Assoc [("offset", expr_string e1); ("multiplier", expr_string e2)]

Check warning on line 42 in src/frontend/Info.ml

View check run for this annotation

Codecov / codecov/patch

src/frontend/Info.ml#L42

Added line #L42 was not covered by tests
| Ordered -> transform (`String "ordered")
| PositiveOrdered -> transform (`String "positive_ordered")
| Simplex -> transform (`String "simplex")
| UnitVector -> transform (`String "unit_vector")
| SumToZero -> transform (`String "sum_to_zero")

Check warning on line 47 in src/frontend/Info.ml

View check run for this annotation

Codecov / codecov/patch

src/frontend/Info.ml#L47

Added line #L47 was not covered by tests
| CholeskyCorr -> transform (`String "cholesky_corr")
| CholeskyCov -> transform (`String "cholesky_cov")
| Correlation -> transform (`String "correlation")
| Covariance -> transform (`String "covariance")
| StochasticRow -> transform (`String "stochastic_row")
| StochasticColumn -> transform (`String "stochastic_column")

Check warning on line 53 in src/frontend/Info.ml

View check run for this annotation

Codecov / codecov/patch

src/frontend/Info.ml#L52-L53

Added lines #L52 - L53 were not covered by tests
| TupleTransformation ts ->
transform (`List (List.map ~f:(fun t -> `Assoc (transformation t)) ts))

let get_var_decl {stmts; _} : t =
`Assoc
(List.fold_right ~init:[]
~f:(fun stmt acc ->
match stmt.Ast.stmt with
| Ast.VarDecl decl ->
let type_info = basetype_dims decl.decl_type in
let transform_info = transformation decl.transformation in
let decl_info =
List.map
~f:(fun {identifier; _} -> (identifier.name, type_info))
~f:(fun {identifier; _} ->
(identifier.name, `Assoc (type_info @ transform_info)))
decl.variables in
decl_info @ acc
| _ -> acc)
Expand Down
97 changes: 70 additions & 27 deletions test/integration/cli-args/info/info.expected
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
$ ../../../../../install/default/bin/stanc --include-paths=.,includes --info info.stan
{
"inputs": {
"a": { "type": "int", "dimensions": 0 },
"b": { "type": "real", "dimensions": 0 },
"c": { "type": "real", "dimensions": 1 },
"d1": { "type": "real", "dimensions": 1 },
"d2": { "type": "real", "dimensions": 1 },
"e": { "type": "real", "dimensions": 2 },
"f": { "type": "int", "dimensions": 1 },
"g": { "type": "real", "dimensions": 1 },
"h": { "type": "real", "dimensions": 2 },
"i": { "type": "real", "dimensions": 3 },
"j": { "type": "int", "dimensions": 3 },
"cplx": { "type": "complex", "dimensions": 1 },
"cplx_vec": { "type": "complex", "dimensions": 1 },
"cplx_row": { "type": "complex", "dimensions": 1 },
"cplx_mat": { "type": "complex", "dimensions": 2 },
"a": { "type": "int", "dimensions": 0, "constraint": "none" },
"b": { "type": "real", "dimensions": 0, "constraint": "none" },
"c": { "type": "real", "dimensions": 1, "constraint": "none" },
"d1": { "type": "real", "dimensions": 1, "constraint": "none" },
"d2": { "type": "real", "dimensions": 1, "constraint": "none" },
"e": { "type": "real", "dimensions": 2, "constraint": "none" },
"f": { "type": "int", "dimensions": 1, "constraint": "none" },
"g": { "type": "real", "dimensions": 1, "constraint": "none" },
"h": { "type": "real", "dimensions": 2, "constraint": "none" },
"i": { "type": "real", "dimensions": 3, "constraint": "none" },
"j": { "type": "int", "dimensions": 3, "constraint": "none" },
"cplx": { "type": "complex", "dimensions": 1, "constraint": "none" },
"cplx_vec": { "type": "complex", "dimensions": 1, "constraint": "none" },
"cplx_row": { "type": "complex", "dimensions": 1, "constraint": "none" },
"cplx_mat": { "type": "complex", "dimensions": 2, "constraint": "none" },
"tuples": {
"type": [
{ "type": "int", "dimensions": 0 },
Expand All @@ -28,22 +28,65 @@
"dimensions": 0
}
],
"dimensions": 1
"dimensions": 1,
"constraint": [
{ "constraint": "none" },
{ "constraint": "none" },
{
"constraint": [
{ "constraint": "none" }, { "constraint": "none" }
]
}
]
}
},
"parameters": {
"l": { "type": "real", "dimensions": 1 },
"m": { "type": "real", "dimensions": 1 },
"n": { "type": "real", "dimensions": 1 },
"o": { "type": "real", "dimensions": 1 },
"p": { "type": "real", "dimensions": 2 },
"q": { "type": "real", "dimensions": 2 },
"r": { "type": "real", "dimensions": 2 },
"s": { "type": "real", "dimensions": 2 },
"y": { "type": "real", "dimensions": 0 }
"low": {
"type": "real",
"dimensions": 0,
"constraint": { "lower": "0" }
},
"l": { "type": "real", "dimensions": 1, "constraint": "simplex" },
"m": { "type": "real", "dimensions": 1, "constraint": "unit_vector" },
"n": { "type": "real", "dimensions": 1, "constraint": "ordered" },
"o": {
"type": "real",
"dimensions": 1,
"constraint": "positive_ordered"
},
"p": { "type": "real", "dimensions": 2, "constraint": "covariance" },
"q": { "type": "real", "dimensions": 2, "constraint": "correlation" },
"r": { "type": "real", "dimensions": 2, "constraint": "cholesky_cov" },
"s": { "type": "real", "dimensions": 2, "constraint": "cholesky_corr" },
"y": { "type": "real", "dimensions": 0, "constraint": "none" },
"parameter_transforms": {
"type": [
{ "type": "real", "dimensions": 0 },
{
"type": [
{ "type": "real", "dimensions": 1 },
{ "type": "real", "dimensions": 2 }
],
"dimensions": 0
}
],
"dimensions": 0,
"constraint": [
{ "constraint": { "lower": "y" } },
{
"constraint": [
{ "constraint": "simplex" }, { "constraint": "covariance" }
]
}
]
}
},
"transformed parameters": {
"t": { "type": "real", "dimensions": 2, "constraint": "none" }
},
"generated quantities": {
"u": { "type": "real", "dimensions": 0, "constraint": "none" }
},
"transformed parameters": { "t": { "type": "real", "dimensions": 2 } },
"generated quantities": { "u": { "type": "real", "dimensions": 0 } },
"functions": [
"fatal_error", "log", "print", "reduce_sum", "reject", "sin", "square"
],
Expand Down
3 changes: 3 additions & 0 deletions test/integration/cli-args/info/info.stan
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ transformed data {
}

parameters {
real <lower=0> low;
simplex[10] l;
unit_vector[11] m;
ordered[12] n;
Expand All @@ -46,6 +47,8 @@ parameters {
cholesky_factor_cov[16] r;
cholesky_factor_corr[17] s;
real y;

tuple(real<lower=y>, tuple(simplex[18], cov_matrix[19])) parameter_transforms;
}

transformed parameters {
Expand Down
44 changes: 24 additions & 20 deletions test/stancjs/stancjs.expected
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ data {
}

{
"inputs": { "a": { "type": "int", "dimensions": 0 } },
"inputs": { "a": { "type": "int", "dimensions": 0, "constraint": "none" } },
"parameters": {},
"transformed parameters": {},
"generated quantities": {},
Expand Down Expand Up @@ -283,27 +283,31 @@ File include/a.stan recursively included itself.
$ node info.js
{
"inputs": {
"a": { "type": "int", "dimensions": 0 },
"b": { "type": "real", "dimensions": 0 },
"c": { "type": "real", "dimensions": 1 },
"d": { "type": "real", "dimensions": 1 },
"e": { "type": "real", "dimensions": 2 },
"f": { "type": "int", "dimensions": 1 },
"g": { "type": "real", "dimensions": 1 },
"h": { "type": "real", "dimensions": 2 },
"i": { "type": "real", "dimensions": 3 },
"j": { "type": "int", "dimensions": 3 }
"a": { "type": "int", "dimensions": 0, "constraint": "none" },
"b": { "type": "real", "dimensions": 0, "constraint": "none" },
"c": { "type": "real", "dimensions": 1, "constraint": "none" },
"d": { "type": "real", "dimensions": 1, "constraint": "none" },
"e": { "type": "real", "dimensions": 2, "constraint": "none" },
"f": { "type": "int", "dimensions": 1, "constraint": "none" },
"g": { "type": "real", "dimensions": 1, "constraint": "none" },
"h": { "type": "real", "dimensions": 2, "constraint": "none" },
"i": { "type": "real", "dimensions": 3, "constraint": "none" },
"j": { "type": "int", "dimensions": 3, "constraint": "none" }
},
"parameters": {
"l": { "type": "real", "dimensions": 1 },
"m": { "type": "real", "dimensions": 1 },
"n": { "type": "real", "dimensions": 1 },
"o": { "type": "real", "dimensions": 1 },
"p": { "type": "real", "dimensions": 2 },
"q": { "type": "real", "dimensions": 2 },
"r": { "type": "real", "dimensions": 2 },
"s": { "type": "real", "dimensions": 2 },
"y": { "type": "real", "dimensions": 0 }
"l": { "type": "real", "dimensions": 1, "constraint": "simplex" },
"m": { "type": "real", "dimensions": 1, "constraint": "unit_vector" },
"n": { "type": "real", "dimensions": 1, "constraint": "ordered" },
"o": {
"type": "real",
"dimensions": 1,
"constraint": "positive_ordered"
},
"p": { "type": "real", "dimensions": 2, "constraint": "covariance" },
"q": { "type": "real", "dimensions": 2, "constraint": "correlation" },
"r": { "type": "real", "dimensions": 2, "constraint": "cholesky_cov" },
"s": { "type": "real", "dimensions": 2, "constraint": "cholesky_corr" },
"y": { "type": "real", "dimensions": 0, "constraint": "none" }
},
"transformed parameters": {},
"generated quantities": {},
Expand Down