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

504 docstring formatting #757

Merged
merged 256 commits into from
Apr 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
256 commits
Select commit Hold shift + click to select a range
fe18201
2nd Refactorization for ht.datatype
May 28, 2020
fb5faf8
Cosmetics in docstrings
May 28, 2020
88d9ae6
Added Napoleon to Requirements
May 28, 2020
d0eea6d
Fixed custom Autoapi filter usage
May 28, 2020
0fb99ed
Adjusted Requirements on Sphinx packges
May 29, 2020
f8aceda
Remove '.core' from module names, use only short names for classes an…
May 29, 2020
cc118f8
Logo adjustment
May 29, 2020
aa11a1f
Some more cleanups
Jun 3, 2020
b7ec419
Styling and markdown annotation
Jun 4, 2020
3cca460
Color adjustment to See Also and Warning sections
Jun 4, 2020
ff0603c
Finalizing styling: Cross-Referencing, code annotation and substituti…
Jun 5, 2020
a6fb5b0
Finalizing styling: Cross-Referencing, code annotation and substituti…
Jun 5, 2020
69d7b18
Small fix
Jun 5, 2020
0736e62
Merge latest master
Jun 5, 2020
c5c166d
Small fix
Jun 5, 2020
dd98db7
fliplr and flipud docs formatting
ClaudiaComito Jun 5, 2020
241be5f
Some more fixes
Jun 5, 2020
4144aaf
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Jun 5, 2020
53fb31b
Some more fixes
Jun 5, 2020
2f5e344
Adjust custom.css for menu rendering
Jun 5, 2020
0628318
Adjust custom.css for menu
Jun 5, 2020
942bd26
Try formatting sustainability
Jun 13, 2020
7a896d5
Try formatting sustainability again
Jun 13, 2020
94ec9a8
Merging latest master
Jul 1, 2020
f1146d2
Test Circular dependency
Jul 2, 2020
f282baf
Test Circular dependency
Jul 2, 2020
eadecd4
DNDarray Method Aliasing for arithmetics functions
Jul 2, 2020
0960877
DNDarray Method Aliasing for exponential functions
Jul 2, 2020
a2ce2ff
DNDarray Method Aliasing for indexing functions
Jul 2, 2020
17c7f60
DNDarray Method Aliasing for logical functions
Jul 2, 2020
94b73f3
DNDarray Method Aliasing for manipulation functions
Jul 2, 2020
5a02b6f
DNDarray Method Aliasing for relational functions
Jul 2, 2020
d8af4a8
DNDarray Method Aliasing for rounding functions
Jul 2, 2020
365c7d5
DNDarray Method Aliasing for statistics functions
Jul 2, 2020
557fe73
DNDarray Method Aliasing for trigonometric functions
Jul 2, 2020
d57aa83
DNDarray Method Aliasing for memory functions
Jul 2, 2020
6bfa16b
DNDarray Method Aliasing for linalg basics functions
Jul 2, 2020
67c335a
DNDarray Method Aliasing for linalg basics functions 2
Jul 2, 2020
aedfd6b
DNDarray Method Aliasing for io functions
Jul 2, 2020
0258505
Import error fix
Jul 2, 2020
bc1159a
Import error fix
Jul 2, 2020
f365613
Import error fix
Jul 2, 2020
0dc69eb
Fiddeling around with circular dependencies
Jul 2, 2020
b618194
Fiddeling around with circular dependencies
Jul 2, 2020
a5fae20
Minor change
Jul 3, 2020
d415534
First Version of manual on how to write HeAT docstrings
Jul 5, 2020
870aa2c
Add documentation_howto to toctree
Jul 5, 2020
338df6d
Rename Documentation_HowTo.rst to documentation_howto.rst
Cdebus Jul 5, 2020
e267607
daniel's doc updates
coquelin77 Jul 6, 2020
d0a4dd5
Merge branch 'master' into 504-docstring-formatting
coquelin77 Jul 6, 2020
6f2cf8e
Merge branch 'master' into 504-docstring-formatting
coquelin77 Jul 6, 2020
e05bc40
Added parameter type annotations to kmeans.py, base.py, io.py and ran…
Markus-Goetz Jul 6, 2020
52a584c
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Jul 6, 2020
1a2fa4f
Add python 3.7 minimum requirement
rainman110 Jul 8, 2020
0adb105
Merge branch 'master' into 504-docstring-formatting
ClaudiaComito Jul 13, 2020
8d6fdde
Add parameter type hints, format docs.
ClaudiaComito Jul 13, 2020
c60ce8a
Add parameter type hints
ClaudiaComito Jul 14, 2020
1f9871b
Add parameter type hints
ClaudiaComito Jul 14, 2020
4860e34
Parameter type hints first few changes
ClaudiaComito Jul 14, 2020
1ec1b70
matrixgallery: add parameter hints and update docs
Jul 14, 2020
9fc1189
Break Cyclic Dependecies in dndarray.py. Fixed some parameter type an…
Jul 14, 2020
1d9c889
Added default arguments for io.py and random.py
Markus-Goetz Jul 14, 2020
db6a003
doc updates from Daniel
coquelin77 Jul 14, 2020
34c6b17
Added parameter annotations for devices and factories. Moved TODOs in…
Markus-Goetz Jul 14, 2020
0d75e5a
Merge remote-tracking branch 'refs/remotes/origin/504-docstring-forma…
Markus-Goetz Jul 14, 2020
acbacfa
Added documentation and parameter annotations for constants and logical
Markus-Goetz Jul 14, 2020
838fe17
Adding Parameter Type Hints, Writing Docstrings for Communications.py
Jul 15, 2020
822eba7
Fixed conf.py for napoleon usage with sphinx>1.3
Jul 15, 2020
632f946
Parameter type annotations for memory, stride tricks and trigonometri…
Markus-Goetz Jul 15, 2020
6ed64b3
Fiddeling around with html style of lists
Jul 15, 2020
33ea12b
more doc changes, tests failing in communication
coquelin77 Jul 15, 2020
22f3351
Reworked Getting Started section
Markus-Goetz Jul 17, 2020
bff04bd
fix spelling reStructuredText
mtar Jul 20, 2020
31f41bd
Introduced tutorial page
Markus-Goetz Jul 20, 2020
2e5ac68
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Jul 20, 2020
50fb468
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Jul 20, 2020
dca4518
ReturnType annotation for Communication.py
Jul 20, 2020
57860ef
add variable docstrings, parameters
mtar Jul 21, 2020
64377d7
Finished 30min tutorial
Markus-Goetz Jul 21, 2020
f7d252d
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Jul 21, 2020
f5191fb
device doctrings
mtar Jul 21, 2020
d4879e6
Fill tutorial on cluster analysis
Jul 21, 2020
d2614aa
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Jul 21, 2020
0ed45cb
Fix mergeconflicts
Jul 21, 2020
ffbed1f
docstring update
mtar Jul 21, 2020
9892490
update example output
mtar Jul 21, 2020
306ee6d
update output array examples
mtar Jul 21, 2020
54a7035
update all output examples
mtar Jul 22, 2020
40da5ee
Assorted Bugfixes
Jul 22, 2020
39c2c9d
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Jul 22, 2020
b2eeb73
Finishing K_cluster tutorial
Jul 22, 2020
ef84296
Fix TocTree
Jul 22, 2020
f57eca4
Fix TocTree
Jul 22, 2020
dfc48f4
update output of examples
mtar Jul 22, 2020
10876b5
Fix TocTree
Jul 22, 2020
72f2045
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Jul 22, 2020
efe765c
Trying to fix RTD
Jul 22, 2020
8a6da9c
Trying to fix RTD
Jul 22, 2020
e982579
Add images to clustering tutorial
Jul 22, 2020
5921b2d
Enhancing Tutorial
Jul 22, 2020
f656db5
Added parallel computation documentation
Markus-Goetz Jul 22, 2020
bbd9708
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Jul 22, 2020
dd0bf71
Add images
Jul 22, 2020
219d480
Added ht.constant.PI
Jul 22, 2020
1fab6f6
Added case studies
Markus-Goetz Jul 23, 2020
14993de
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Jul 23, 2020
72350a1
Merging latest master and enhancing docstring for cluster algorithms
Jul 23, 2020
f240724
Minor test bugfix
Jul 23, 2020
4c9a3bc
Fixed image rendering in Tutorial
Jul 23, 2020
6d4c180
parameter type hints for rounding.py
Jul 27, 2020
0d94161
parameter type hints for types.py
Jul 27, 2020
2abcc2f
fixing type annotations for datatype
Jul 28, 2020
d34019d
fix type hints for arange function
Jul 28, 2020
96dcf2c
fix type hints for sanitize_device function
Jul 28, 2020
3b2d5d6
fix type hints for sanitize_comm
Jul 28, 2020
8909b56
fix type hints for sanitize_axis
Jul 28, 2020
b2a88ac
Fixed typos in tutorials, renamed images to have lowercase names
Markus-Goetz Jul 28, 2020
e76b92e
Added configuration for pydocstyle
rainman110 Aug 3, 2020
43311a9
Added pre-commit hook for doc linter
rainman110 Aug 3, 2020
d93a981
testing folder exclusion
coquelin77 Aug 20, 2020
ed3ae45
added test exclusion to pydocstyle hook
coquelin77 Aug 20, 2020
11618e7
Fix clustering example not compilable
sebimarkgraf Nov 6, 2020
2ca0f17
Merge pull request #693 from sebimarkgraf/fix-cluster-example
Cdebus Nov 6, 2020
5973f6e
Mention Stackoverflow support channel in documentation
bhagemeier Dec 10, 2020
803f221
Proper reStructuredText formatting
bhagemeier Dec 15, 2020
e88a489
Merged Master; Potentially needs fixes
Cdebus Mar 26, 2021
e50f38e
Merge branch '504-docstring-formatting' into 588_docstyle_linting
Cdebus Mar 29, 2021
f01dfbc
Merge pull request #646 from helmholtz-analytics/588_docstyle_linting
Cdebus Mar 29, 2021
a0f018a
Adjusted pre-commit to exclude folders for docstring linting
Cdebus Mar 30, 2021
4c30018
removed example from docstring linting in precommit
coquelin77 Mar 30, 2021
2948524
removed more unit test files from precommit doc hook (not automatic)
coquelin77 Mar 30, 2021
085e985
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Mar 30, 2021
a7f0546
added d107 to ignore list
coquelin77 Mar 30, 2021
1c141d4
Added docstrings for the version module
Markus-Goetz Mar 30, 2021
532aa4a
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 30, 2021
ca2a3a0
Fixed version.py rendering
Markus-Goetz Mar 30, 2021
4d235fb
doc updates to the optim package
coquelin77 Mar 30, 2021
64f1052
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Mar 30, 2021
b3dcfa1
doc updates to the nn module, reder need to be checked
coquelin77 Mar 30, 2021
d0b447d
Added docstrings and type annotations to printing.py, pydocstyle and …
Markus-Goetz Mar 30, 2021
70d9725
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 30, 2021
c153b7e
Fixed imports, added docstrings, removed and added type annotations f…
Markus-Goetz Mar 30, 2021
5a9e66a
utils doc updates, render not checked
coquelin77 Mar 30, 2021
b8a0bb1
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Mar 30, 2021
ff5fc48
updated tiling docs, have not checked render
coquelin77 Mar 30, 2021
a31407f
Docstring fix for complex_math.py
mtar Mar 30, 2021
0b081bf
docstring update
ClaudiaComito Mar 30, 2021
8bfcbc9
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Mar 30, 2021
8742822
docstring constants.py
mtar Mar 30, 2021
b51ffd2
Introduced variable annotations for version
Markus-Goetz Mar 30, 2021
32c0c2d
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 30, 2021
c2ba115
add missing annotations
mtar Mar 30, 2021
60c5d82
links and such corrections for dp_optimizer file, render checked
coquelin77 Mar 30, 2021
dc53d8b
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Mar 30, 2021
a672d69
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
mtar Mar 30, 2021
1ddb69a
Reintroduced parameter type annotations for base.py
Markus-Goetz Mar 30, 2021
1b994f5
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 30, 2021
a030325
reduce on LR plateau updated for rendering
coquelin77 Mar 30, 2021
a806744
update docstring, ignore D402
ClaudiaComito Mar 30, 2021
c9e0939
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Mar 30, 2021
a4d8041
docstring update
ClaudiaComito Mar 30, 2021
c1b0413
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
mtar Mar 30, 2021
b1b550a
docstring update
ClaudiaComito Mar 30, 2021
7defc95
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
mtar Mar 30, 2021
97c80df
docstring update GaussianNB
ClaudiaComito Mar 30, 2021
dd16005
update examples
mtar Mar 30, 2021
8d18a06
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Mar 30, 2021
c5450eb
nn, optim, utils doc updates with render check
coquelin77 Mar 30, 2021
53b316a
docstring update
ClaudiaComito Mar 30, 2021
2208498
docstring update
ClaudiaComito Mar 30, 2021
ddd4abc
Use a valid Pygments lexer
bhagemeier Mar 30, 2021
0335ba6
Add tutorials to the structure
bhagemeier Mar 30, 2021
143e5f2
Removed undocumented variables from documentation. Cleaned up clustering
Cdebus Mar 30, 2021
2104bfe
Merged latest greatest
Cdebus Mar 30, 2021
8eeb1aa
docstring update
ClaudiaComito Mar 30, 2021
35f9dde
Fix typo
bhagemeier Mar 30, 2021
a512113
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Mar 30, 2021
dc61b72
Remove empty DPNN tutorial
bhagemeier Mar 30, 2021
14d6ceb
Added docstring and type annotations for the random module
Markus-Goetz Mar 30, 2021
bf55c53
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 30, 2021
65129c4
Reworked base.py and io.py to comply with changes in docstring format…
Markus-Goetz Mar 30, 2021
132972f
updating docstrings exponential
mtar Mar 31, 2021
381cadc
update docstring memory.py
mtar Mar 31, 2021
028c170
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Mar 31, 2021
17f4bfb
Fix for circular dependencies. Most tests can now be executed again, …
Markus-Goetz Mar 31, 2021
61f8788
Docstring updates
ClaudiaComito Apr 1, 2021
35bb525
kurtosis, Fix warnings
ClaudiaComito Apr 1, 2021
2d8b02d
Examples
ClaudiaComito Apr 1, 2021
3e3b63c
shapes update
ClaudiaComito Apr 1, 2021
4d0482e
added device called to counter_sequence in random.py
coquelin77 Apr 1, 2021
0fb2786
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Apr 1, 2021
a6aea9e
removed numdims warning in ndim function
coquelin77 Apr 1, 2021
8a4ceb5
fixed prints in examples in tiling docs
coquelin77 Apr 1, 2021
7c1ea4a
added DNDarray.__ne__ to namespace for != operations
coquelin77 Apr 1, 2021
3060832
corrected lambda call for qr function
coquelin77 Apr 1, 2021
56bdf1b
Documentation for DNDarray.py
Cdebus Apr 1, 2021
8292dd6
Merged latest Commits
Cdebus Apr 1, 2021
ad1a60a
Docs update
ClaudiaComito Apr 1, 2021
78bd96c
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Apr 1, 2021
4da5ce8
docs
ClaudiaComito Apr 1, 2021
f7ef5dc
unittest corrections on 1 process, still failing for more procs
coquelin77 Apr 1, 2021
ad34c1a
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Apr 1, 2021
832769d
DEBUGGING: GNB failing at 2 processes. + typing.object in sanitations…
coquelin77 Apr 1, 2021
dad2373
bug == squashed. tests running (at least with 1, 2, 5, and 7 procs)
coquelin77 Apr 1, 2021
6d724bb
Reworked docstrings and examples for knn, modified code might break
Markus-Goetz Apr 1, 2021
733f85c
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
Markus-Goetz Apr 1, 2021
593de7d
Fixing kNN tests
Markus-Goetz Apr 1, 2021
5c41a2a
Fixed typos in random.py and io.py
Markus-Goetz Apr 1, 2021
4ba91d3
fixed error message in pre-commit yaml, added module level docs in mo…
coquelin77 Apr 6, 2021
8cd84f3
links in docs
coquelin77 Apr 6, 2021
4e1c743
public method doc strings
coquelin77 Apr 6, 2021
4a189ca
Docstrings for spatial and graph
Cdebus Apr 6, 2021
6765aff
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Cdebus Apr 6, 2021
081651c
Docstrings for arithmetics
Cdebus Apr 6, 2021
770f916
added docutils to extra require in setup
coquelin77 Apr 6, 2021
ee6d5fa
corrected doc strings in indexing.py logical.py relational.py roundin…
krajsek Apr 6, 2021
264aace
general doc updates to fix precommit errors, render not checked
coquelin77 Apr 7, 2021
69d2200
lasso docstring updates
coquelin77 Apr 7, 2021
68fd62d
corrected doc strings in heat/regression/lasso.py
krajsek Apr 7, 2021
10151c0
corrected lasso.py
krajsek Apr 7, 2021
8ae23ba
corrected doc strings in lasso.py
krajsek Apr 7, 2021
b8e8af7
Merge branch 'bug/sort-balance' into 504-docstring-formatting
ClaudiaComito Apr 11, 2021
d787ca3
fixing docstring devices
mtar Apr 12, 2021
4fd962b
fix type typos
mtar Apr 12, 2021
e328816
dead code removal and other minor changes
coquelin77 Apr 12, 2021
a5a8e15
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Apr 12, 2021
704bd2a
more devices docstring corrections
coquelin77 Apr 12, 2021
9f537c3
Merge branch '504-docstring-formatting' of github.com:helmholtz-analy…
ClaudiaComito Apr 12, 2021
678ad77
lasso updates, merge make minor change at top level
coquelin77 Apr 12, 2021
3d69687
minor doc change to attempt to wake up unittesting env
coquelin77 Apr 12, 2021
66880a5
Added factories docstrings
Markus-Goetz Apr 14, 2021
71f0053
Resolution of module-level docstring merge conflict
Markus-Goetz Apr 14, 2021
39c3dad
Added separate Raises section for factories, fixed math mode formatti…
Markus-Goetz Apr 14, 2021
2a3aff8
corrected device mistake in qr docs
coquelin77 Apr 15, 2021
ab6f838
import order correction
coquelin77 Apr 15, 2021
896570c
distance tests use allclose instead of equal to deal with floating po…
coquelin77 Apr 16, 2021
49f90ad
updated netcdf python package requirements
coquelin77 Apr 16, 2021
4210277
dtype corrections in distance tests
coquelin77 Apr 16, 2021
5e08981
clarity name change for bf16 MPI op, copy tensor to check in DPNN tests
coquelin77 Apr 19, 2021
1dec860
check if torch.distributed is already initializaed in DASO tests
coquelin77 Apr 19, 2021
8dea683
fall back to MPI.SUM for classic DPNN hooks' synch operations due to …
coquelin77 Apr 19, 2021
806b2a8
Merge branch 'master' into 504-docstring-formatting
coquelin77 Apr 19, 2021
875daa7
updated torchvision requirement
coquelin77 Apr 19, 2021
ca0a627
Cleanup of Docstrings for rendering
Cdebus Apr 19, 2021
861752d
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
Cdebus Apr 19, 2021
fdb076b
docstring corrections
coquelin77 Apr 19, 2021
242507d
Merge branch '504-docstring-formatting' of https://github.com/helmhol…
coquelin77 Apr 19, 2021
7328b75
added doc install / run instructions to howto file
coquelin77 Apr 20, 2021
be0d5d1
corrected typo in setattr docs
coquelin77 Apr 20, 2021
e1569a4
corrected typo in setattr docs
coquelin77 Apr 20, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ repos:
rev: 19.3b0
hooks:
- id: black
- repo: https://github.com/pycqa/pydocstyle
rev: 5.0.1 # pick a git hash / tag to point to
hooks:
- id: pydocstyle
exclude: 'tests|benchmarks|examples|scripts|setup.py' #|heat/utils/data/mnist.py|heat/utils/data/_utils.py ?
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
- [#519](https://github.com/helmholtz-analytics/heat/pull/519) Bugfix: distributed slicing with empty list or scalar as input; distributed nonzero() of empty (local) tensor.
- [#520](https://github.com/helmholtz-analytics/heat/pull/520) Bugfix: Resplit returns correct values now.
- [#520](https://github.com/helmholtz-analytics/heat/pull/520) Feature: SplitTiles class, used in new resplit, tiles with theoretical and actual split axes
- [#521](https://github.com/helmholtz-analytics/heat/pull/521) Add documentation for the generic reduce_op in Heat's core
- [#521](https://github.com/helmholtz-analytics/heat/pull/521) Add documentation for the dtype reduce_op in Heat's core
- [#522](https://github.com/helmholtz-analytics/heat/pull/522) Added CUDA-aware MPI detection for MVAPICH, MPICH and ParaStation.
- [#524](https://github.com/helmholtz-analytics/heat/pull/524) New Feature: cumsum & cumprod
- [#526](https://github.com/helmholtz-analytics/heat/pull/526) float32 is now consistent default dtype for factories.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ analytics and machine learning. It provides highly optimized algorithms and data
structures for tensor computations using CPUs, GPUs and distributed cluster
systems on top of MPI. The goal of HeAT is to fill the gap between data
analytics and machine learning libraries with a strong focus on single-node
performance, and traditional high-performance computing (HPC). HeAT's generic
performance, and traditional high-performance computing (HPC). HeAT's dtype
Python-first programming interface integrates seamlessly with the existing data
science ecosystem and makes it as effortless as using numpy to write scalable
scientific and data science applications.
Expand Down Expand Up @@ -62,6 +62,7 @@ tag it with "pyheat".
Requirements
------------

HeAT requires Python 3.7 or newer.
HeAT is based on [PyTorch](https://pytorch.org/). Specifially, we are exploiting
PyTorch's support for GPUs *and* MPI parallelism. For MPI support we utilize
[mpi4py](https://mpi4py.readthedocs.io). Both packages can be installed via pip
Expand Down
492 changes: 492 additions & 0 deletions doc/images/bsp.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/clustering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/logo_emblem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 105 additions & 0 deletions doc/images/logo_emblem.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/logo_heAT.pdf
Binary file not shown.
Loading