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

Updated the tutorial document. #977

Merged
merged 7 commits into from
Jun 1, 2022

Conversation

Sai-Suraj-27
Copy link
Collaborator

@Sai-Suraj-27 Sai-Suraj-27 commented May 27, 2022

Description

Corrected some mistakes in the tutorial document.

  1. Corrected the spelling mistake -> (sigular to single)
  2. Corrected the statement -> the number of dimensions is the rank of the array.
  3. Made 2 more small changes.

Issue/s resolved: #

Type of change

Documentation update

Due Diligence

  • All split configurations tested
  • Multiple dtypes tested in relevant functions
  • Documentation updated (if needed)
  • Updated changelog.md under the title "Pending Additions"

Does this change modify the behaviour of other functions? If so, which?

No.

1. Corrected the spelling mistake -> (sigular to single)
2. Corrected the statement -> the number of dimensions is the rank of the array.
3. Made 2 more small changes.
@mtar
Copy link
Collaborator

mtar commented May 27, 2022

GPU cluster tests are currently disabled on this Pull Request.

@ghost
Copy link

ghost commented May 27, 2022

👇 Click on the image for a new way to code review
  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

@codecov
Copy link

codecov bot commented May 27, 2022

Codecov Report

Merging #977 (29a927f) into main (231831e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #977   +/-   ##
=======================================
  Coverage   91.10%   91.10%           
=======================================
  Files          65       65           
  Lines        9976     9976           
=======================================
  Hits         9089     9089           
  Misses        887      887           
Flag Coverage Δ
unit 91.10% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 231831e...29a927f. Read the comment docs.

ClaudiaComito
ClaudiaComito previously approved these changes Jun 1, 2022
Copy link
Contributor

@ClaudiaComito ClaudiaComito left a comment

Choose a reason for hiding this comment

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

Thanks a lot @SaiSuraj27 , indeed it looks much better now. Just one small edit needed.

scripts/tutorial.ipynb Outdated Show resolved Hide resolved
@ClaudiaComito
Copy link
Contributor

run tests

@ClaudiaComito
Copy link
Contributor

run tests

Copy link
Contributor

@ClaudiaComito ClaudiaComito left a comment

Choose a reason for hiding this comment

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

Thanks a lot @SaiSuraj27 !

@ClaudiaComito ClaudiaComito merged commit c1ef707 into helmholtz-analytics:main Jun 1, 2022
@JuanPedroGHM JuanPedroGHM added the documentation Anything related to documentation label Jun 3, 2022
ClaudiaComito added a commit that referenced this pull request Sep 13, 2022
* Replace bug report MD template with form in view of further automation

* Fix bug report file name

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Auto generated release notes and changelog (#974)

* wip: Initial release draft and changelog updater actions configuration

* doc: pr title style guide in contibuting.md

* ci: improved release draft templates

* ci: extra release draft categories

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Tutorial note about local and global printing (#972)

* doc: parallel tutorial note metioning local and global printing

* doc: extenden local print note with ``ht.local_printing()``

* Fix typo

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Updated the tutorial document. (#977)

* Updated the tutorial document.

1. Corrected the spelling mistake -> (sigular to single)
2. Corrected the statement -> the number of dimensions is the rank of the array.
3. Made 2 more small changes.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix typo

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Set write permissions for workflow

* Update schedule

* Update schedule

* Update schedule

* Move pytorch version file out of workflows dir

* Update paths

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/psf/black: 22.3.0 → 22.6.0](psf/black@22.3.0...22.6.0)

* Push pytorch release update to release/1.2.x branch, not main

* Update schedule

* Bypass  `on push` trigger

* Update schedule

* Fix condition syntax

* Fix syntax

* On push trigger workaround

* Update schedule

* Update schedule

* Enable non-negative sample size

* Read `min` value directly from torch return object

* Enable non-negative number of samples for `logspace`

* Add test for `logspace`

* Add MPI version field to bug report template

* fix: set cuda rng state on gpu tests for test_random.py (#1014)

* Test latest pyorch on both main and release branch

* Move pytorch release record out of workflows directory

* Update paths

* New PyTorch release

* Temporarily remove trigger

* Update pytorch-latest.txt

* Reinstate trigger

* New PyTorch release

* Remove matrix strategy

* Update pytorch-latest.txt

* New PyTorch release

* New PyTorch release

* fix: set cuda rng state on gpu tests for test_random.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added tests for python 3.9 and pytorch 1.12

Co-authored-by: Claudia Comito <c.comito@fz-juelich.de>
Co-authored-by: Daniel Coquelin <daniel.coquelin@gmail.com>
Co-authored-by: ClaudiaComito <c.comito@fz-juelich.de@users.noreply.github.com>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Create mirrorci.yml

* Create .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Update .gitlab-ci.yml

* Delete Jenkinsfile

* trigger on main and release branches + PRs only

* revert

* add parallel hdf5 & netcdf

* optional dependencies activated

* exclude python 3.9 + pytorch 1.7

* Update torch 1.9 etc. versions

Co-authored-by: Claudia Comito <c.comito@fz-juelich.de>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: JuanPedroGHM <juanpedroghm@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: SaiSuraj27 <87087741+SaiSuraj27@users.noreply.github.com>
Co-authored-by: neosunhan <neosunhan@gmail.com>
Co-authored-by: Markus Goetz <markus.goetz@kit.edu>
Co-authored-by: Daniel Coquelin <daniel.coquelin@gmail.com>
Co-authored-by: ClaudiaComito <c.comito@fz-juelich.de@users.noreply.github.com>
ClaudiaComito added a commit that referenced this pull request Nov 3, 2022
…ompatible shapes of local arrays (#1034)

* Replace bug report MD template with form in view of further automation

* Fix bug report file name

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Auto generated release notes and changelog (#974)

* wip: Initial release draft and changelog updater actions configuration

* doc: pr title style guide in contibuting.md

* ci: improved release draft templates

* ci: extra release draft categories

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Tutorial note about local and global printing (#972)

* doc: parallel tutorial note metioning local and global printing

* doc: extenden local print note with ``ht.local_printing()``

* Fix typo

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Updated the tutorial document. (#977)

* Updated the tutorial document.

1. Corrected the spelling mistake -> (sigular to single)
2. Corrected the statement -> the number of dimensions is the rank of the array.
3. Made 2 more small changes.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix typo

Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Set write permissions for workflow

* Update schedule

* Update schedule

* Update schedule

* Move pytorch version file out of workflows dir

* Update paths

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/psf/black: 22.3.0 → 22.6.0](psf/black@22.3.0...22.6.0)

* Push pytorch release update to release/1.2.x branch, not main

* Update schedule

* Bypass  `on push` trigger

* Update schedule

* Fix condition syntax

* Fix syntax

* On push trigger workaround

* Update schedule

* Update schedule

* Enable non-negative sample size

* Read `min` value directly from torch return object

* Enable non-negative number of samples for `logspace`

* Add test for `logspace`

* Add MPI version field to bug report template

* fix: set cuda rng state on gpu tests for test_random.py (#1014)

* Test latest pyorch on both main and release branch

* Move pytorch release record out of workflows directory

* Update paths

* New PyTorch release

* Temporarily remove trigger

* Update pytorch-latest.txt

* Reinstate trigger

* New PyTorch release

* Remove matrix strategy

* Update pytorch-latest.txt

* New PyTorch release

* New PyTorch release

* fix: set cuda rng state on gpu tests for test_random.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Added tests for python 3.9 and pytorch 1.12

Co-authored-by: Claudia Comito <c.comito@fz-juelich.de>
Co-authored-by: Daniel Coquelin <daniel.coquelin@gmail.com>
Co-authored-by: ClaudiaComito <c.comito@fz-juelich.de@users.noreply.github.com>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#1024)

updates:
- [github.com/psf/black: 22.6.0 → 22.8.0](psf/black@22.6.0...22.8.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>

* Refactored code for readability

* rename file and activate force push

* Update bug_report.yml

fixes formatting issues

* Update bug_report.yml

fixes an issue where the bug label is not set.

* Update README.md

Use status badge from a different workflow action

* Update codecov.yml

* Update codecov.yml

* Fixed code checking for non-matching local shapes while using is_split + Added test

* Add section `Google Summer of Code 2022`

* Bug/1017 `prod` / `sum` with empty arrays (#1018)

* Check for split in `__reduce_op`

* Check whether x is distributed

Co-authored-by: mtar <m.tarnawa@fz-juelich.de>

Co-authored-by: mtar <m.tarnawa@fz-juelich.de>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>

* Add section "Array API"

* Mirror Repository and run GitHub CI at HZDR (#1032)

* Update ci worflow action

* Update codecov.yml

* Bug/999 Fix `keepdim` in `any`/`all` (#1000)

* Fix `all`

* Fix `any`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add distributed tests

* Expanded tests for combination of axis/split axis

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: mtar <m.tarnawa@fz-juelich.de>

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/psf/black: 22.8.0 → 22.10.0](psf/black@22.8.0...22.10.0)

* Updated error message

Co-authored-by: Claudia Comito <c.comito@fz-juelich.de>
Co-authored-by: Claudia Comito <39374113+ClaudiaComito@users.noreply.github.com>
Co-authored-by: JuanPedroGHM <juanpedroghm@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: SaiSuraj27 <87087741+SaiSuraj27@users.noreply.github.com>
Co-authored-by: neosunhan <neosunhan@gmail.com>
Co-authored-by: Markus Goetz <markus.goetz@kit.edu>
Co-authored-by: mtar <m.tarnawa@fz-juelich.de>
Co-authored-by: Daniel Coquelin <daniel.coquelin@gmail.com>
Co-authored-by: ClaudiaComito <c.comito@fz-juelich.de@users.noreply.github.com>
Co-authored-by: neosunhan <97215518+neosunhan@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants