Skip to content

Commit

Permalink
✅ Improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
EssamWisam committed Sep 1, 2024
1 parent 4458627 commit f1f7dfe
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -200,10 +200,11 @@ 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
`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
`Continuous` or `Multiclass` or `OrderedFactor`; check column scitypes with `schema(X)`.
If `X` is a `Matrix`, it is assumed to be purely continuous and 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.
In case any `Multiclass` or `OrderedFactor` columns appear in `X`, the constructed network will use an `EntityEmbedder` layer
to transform them into dense vectors.
"""

const EMBDOC = """
Expand Down

0 comments on commit f1f7dfe

Please sign in to comment.