Skip to content

Improve docs for EntityEmbedder wrapper #303

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.

Sign up for GitHub

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

Jump to bottom
Open
ablaom opened this issue Apr 7, 2025 · 1 comment · May be fixed by #304
Open

Improve docs for EntityEmbedder wrapper #303

ablaom opened this issue Apr 7, 2025 · 1 comment · May be fixed by #304
Labels
documentation Improvements or additions to documentation

Comments

@ablaom
Copy link
Collaborator

ablaom commented Apr 7, 2025

There is no reference to this wrapper at all in the docs.

Also, the doc string is confusing. What is the model that is bound to the machine? (It is the output of model = EntityEmbedder(model=atomic_model).)
@ablaom ablaom added the documentation Improvements or additions to documentation label Apr 7, 2025
@ablaom
Copy link
Collaborator Author

ablaom commented Apr 7, 2025 •
edited
Loading

By the way, my undestanding is this wrapper turns the atomic supervised model into an unsupervised one (with training target), so that it can be used in a pipeline and be interpreted as a transformer and not a supervised model. Perhaps the example in the docs string could explicitly give a pipeline example.

@ablaom ablaom linked a pull request Apr 8, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve documentation of the entity embedder wrapper FluxML/MLJFlux.jl
1 participant
@ablaom