Skip to content

Improve documentation of the entity embedder wrapper #304

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

Merged
merged 6 commits into from
Jun 26, 2025

Conversation

ablaom
Copy link
Collaborator

@ablaom ablaom commented Apr 8, 2025

Closes #303.

This PR also removes the spam filtering example, which is broken by recent compatibility updates. As it uses RNNs (not officially supported by MLJFlux) and some non-idiomatic MLJ, I could not justify spending more time getting this to work.

@EssamWisam If you can get the spam example to work with latest version of packages listed the Project.toml, then I'll consider a PR to re-instate it.

@ablaom ablaom requested a review from EssamWisam April 9, 2025 04:34
@ablaom
Copy link
Collaborator Author

ablaom commented Jun 26, 2025

@essam, it seems you did not notice and I had forgotten this one. In it I already reworked the EntityEmbedder example and integrated the docstring into the "Interface" section. Sorry to trample on your toes, but I have reverted to my original example here.

I wanted to follow through with this PR because it also removes the RNN example, which had stopped working, as I explain in the initial post above.

@ablaom ablaom merged commit 2919aa9 into dev Jun 26, 2025
4 of 5 checks passed
@ablaom ablaom deleted the entity-embedder-docstring-improvements branch June 26, 2025 05:18
@EssamWisam
Copy link
Collaborator

EssamWisam commented Jun 26, 2025

That's completely alright and yes, I indeed missed this one (perhaps, it was best to split this it into two PRs as that would have made easier to merge the EE change but perhaps wait a little on the other for me to fix it). Thank you so much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve docs for EntityEmbedder wrapper
2 participants