Skip to content
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

Improve docs #8

Merged
merged 5 commits into from
May 24, 2024
Merged

Improve docs #8

merged 5 commits into from
May 24, 2024

Conversation

AlCatt91
Copy link
Collaborator

I put together a quick jupyter notebook to act as introductory walk-through of the library functionalities, and integrated it into the sphinx documentation. Minor changes to README and auxiliary files.

@AlCatt91 AlCatt91 requested a review from danjust May 17, 2024 14:13
@AlCatt91 AlCatt91 mentioned this pull request May 20, 2024
5 tasks
Copy link
Contributor

@danjust danjust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks Alberto! I might suggest some very minor rewording in the notebook in a separate PR

@@ -28,6 +28,21 @@ def jaccard_similarity(
return float(intersection / union)


def _composition_count_worker(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Surprising (at least to me) behaviour of multiprocessing here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was also quite puzzled - it was throwing errors in Python 3.10 but I think worked fine in 3.8?

@AlCatt91
Copy link
Collaborator Author

Thanks for the review, Daniel. I'll start merging, feel free then to open other PRs to suggest modifications - @sbonner0 @martytom same goes for you, of course :)

@AlCatt91 AlCatt91 merged commit 8642f84 into main May 24, 2024
1 check passed
@AlCatt91 AlCatt91 deleted the improve_docs branch May 24, 2024 19:19
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.

2 participants