docs: add gentropy first steps guide #449
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## dev #449 +/- ##
==========================================
+ Coverage 85.67% 85.99% +0.31%
==========================================
Files 89 96 +7
Lines 2101 2627 +526
==========================================
+ Hits 1800 2259 +459
- Misses 301 368 +67
|
* build(deps): bump pandas from 2.1.4 to 2.2.0 (#443) Bumps [pandas](https://github.com/pandas-dev/pandas) from 2.1.4 to 2.2.0. - [Release notes](https://github.com/pandas-dev/pandas/releases) - [Commits](pandas-dev/pandas@v2.1.4...v2.2.0) --- updated-dependencies: - dependency-name: pandas dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps): bump scikit-learn from 1.3.2 to 1.4.0 (#444) Bumps [scikit-learn](https://github.com/scikit-learn/scikit-learn) from 1.3.2 to 1.4.0. - [Release notes](https://github.com/scikit-learn/scikit-learn/releases) - [Commits](scikit-learn/scikit-learn@1.3.2...1.4.0) --- updated-dependencies: - dependency-name: scikit-learn dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test(docs): testing doc snippets proof of concept * docs: extend and test python snippets to all docs * fix: correct typing in apply_class_method_clumping * fix: update imports in doc tests * chore: harmonizing finngen configuration (#454) * chore: harmonizing finngen configuration * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * chore: finalising finngen config update * fix: reverting .env file --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * chore(deps): bump codecov/codecov-action from 3 to 4 (#464) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 4. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](codecov/codecov-action@v3...v4) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ci: ignore patch versions in dependabot (#462) * build(deps-dev): bump ruff from 0.1.8 to 0.2.0 (#465) Bumps [ruff](https://github.com/astral-sh/ruff) from 0.1.8 to 0.2.0. - [Release notes](https://github.com/astral-sh/ruff/releases) - [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md) - [Commits](astral-sh/ruff@v0.1.8...v0.2.0) --- updated-dependencies: - dependency-name: ruff dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump ipython from 8.20.0 to 8.21.0 (#466) Bumps [ipython](https://github.com/ipython/ipython) from 8.20.0 to 8.21.0. - [Release notes](https://github.com/ipython/ipython/releases) - [Commits](ipython/ipython@8.20.0...8.21.0) --- updated-dependencies: - dependency-name: ipython dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): bump pytest-sugar from 0.9.7 to 1.0.0 (#467) Bumps [pytest-sugar](https://github.com/Teemu/pytest-sugar) from 0.9.7 to 1.0.0. - [Release notes](https://github.com/Teemu/pytest-sugar/releases) - [Changelog](https://github.com/Teemu/pytest-sugar/blob/main/CHANGES.rst) - [Commits](Teemu/pytest-sugar@v0.9.7...v1.0.0) --- updated-dependencies: - dependency-name: pytest-sugar dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com> * build(deps-dev): bump google-cloud-dataproc from 5.8.0 to 5.9.0 (#468) Bumps [google-cloud-dataproc](https://github.com/googleapis/google-cloud-python) from 5.8.0 to 5.9.0. - [Release notes](https://github.com/googleapis/google-cloud-python/releases) - [Changelog](https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-documentai/CHANGELOG.md) - [Commits](googleapis/google-cloud-python@google-cloud-dataproc-v5.8.0...google-cloud-dataproc-v5.9.0) --- updated-dependencies: - dependency-name: google-cloud-dataproc dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com> * fix(test): do not create session and pass it as a parameter --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Irene López <irene.lopezs@protonmail.com> Co-authored-by: Daniel Suveges <daniel.suveges@protonmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
d0choa
approved these changes
Feb 5, 2024
There was a problem hiding this comment.
Thank you @ireneisdoomed. I think this will be very valuable for quite a while.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
coauthored with @d0choa
This PR includes changes in the documentation to provide the user with a guide on how to perform basic operations with the package. Inside
How-tos/Python API, we have covered:This will help the user in their journey with the package.
Next steps is to design a more advanced exercise in a Google Colab notebook, with the advantage that it would be run interactively.