Skip to content

Commit

Permalink
Update src/types.jl
Browse files Browse the repository at this point in the history
Co-authored-by: Anthony Blaom, PhD <[email protected]>
  • Loading branch information
EssamWisam and ablaom authored Aug 7, 2024
1 parent 962bbda commit 4ff7cbe
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,9 @@ as described in Entity Embeddings of Categorical Variables by Cheng Guo, Felix B

const XDOC = """
- `X` is either a `Matrix` or any table of input features (eg, a `DataFrame`) whose columns are of scitype
`Finite`; check column scitypes with `schema(X)`. If `X` is a `Matrix`, it is assumed to have columns corresponding to features and rows corresponding to observations.
`Multiclass` or `OrderedFactor`; check column scitypes with `schema(X)`.
If `X` is a `Matrix`, it is assumed to have columns corresponding to features and rows
corresponding to observations.
In case any `Multiclass` or `OrderedFactor` columns appear in `X`, the constructed network will use an `EntityEmbedder` layer to transform them into dense vectors.
"""

Expand Down

0 comments on commit 4ff7cbe

Please sign in to comment.