Skip to content

[JOSS 6532] Clarify what "any function" means #18

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

Closed
dfm opened this issue Apr 22, 2024 · 5 comments · Fixed by #21
Closed

[JOSS 6532] Clarify what "any function" means #18

dfm opened this issue Apr 22, 2024 · 5 comments · Fixed by #21
Assignees

Comments

@dfm
Copy link

dfm commented Apr 22, 2024

This is related to some of the other issues that I've raised, and I think the docs are getting better, but I think there should be a bit more clarity at the top of the README and on the first page of the docs to better motivate what this module does. I'd say that the key point here is that it allows you to expose any functions that can be called from Python, even if it's not written using JAX primitives itself. Right now I feel like the docs aren't quite specific enough about what the use case is here.

ref: openjournals/joss-reviews#6532

@roth-jakob roth-jakob self-assigned this Apr 22, 2024
@roth-jakob roth-jakob linked a pull request Apr 22, 2024 that will close this issue
@roth-jakob
Copy link
Collaborator

Thanks for the feedback! With PR #21 we try to make this clearer. Please let us know if you think further clarification on the use case of JAXbind is needed.

@dfm
Copy link
Author

dfm commented Apr 22, 2024

#21 looks good to me - thanks!

@dfm
Copy link
Author

dfm commented May 5, 2024

I wanted to comment here to note that the JOSS paper should also include some of this updated language. The paper text is still a bit vague on these points. I'm happy to open a separate issue if that would be useful.

@roth-jakob
Copy link
Collaborator

Thanks for your comment!

You might have read the old PDF version from the JOSS issues. I have now updated the PDF in JOSS. Sorry that I forgot about it earlier.

Additionally, with PR #22, we have updated the summary section of the paper. Please let me know if anything is still unclear.

@dfm
Copy link
Author

dfm commented May 6, 2024

Great - thanks!

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 a pull request may close this issue.

2 participants