Skip to content

Commit 7796b00

Browse files
committed
Docs
1 parent 095871f commit 7796b00

File tree

4 files changed

+35
-22
lines changed

4 files changed

+35
-22
lines changed

docs/source/cite.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,8 @@
11
Citation
22
--------
33

4-
Please cite the original work as:
4+
Find the CITATION file called CITATION.cff on Github or cite this software version as:
55

6-
```
7-
@ARTICLE {Trabelsi2017,
8-
author = "Chiheb Trabelsi, Olexa Bilaniuk, Ying Zhang, Dmitriy Serdyuk, Sandeep Subramanian, João Felipe Santos, Soroush Mehri, Negar Rostamzadeh, Yoshua Bengio, Christopher J Pal",
9-
title = "Deep Complex Networks",
10-
journal = "arXiv preprint arXiv:1705.09792",
11-
year = "2017"
12-
}
13-
```
14-
15-
Cite this software version as:
166
```
177
@misc{dramsch2019complex,
188
title = {Complex-Valued Neural Networks in Keras with Tensorflow},
@@ -23,3 +13,14 @@ Cite this software version as:
2313
year = {2019}
2414
}
2515
```
16+
17+
Please cite the original work as:
18+
19+
```
20+
@ARTICLE {Trabelsi2017,
21+
author = "Chiheb Trabelsi, Olexa Bilaniuk, Ying Zhang, Dmitriy Serdyuk, Sandeep Subramanian, João Felipe Santos, Soroush Mehri, Negar Rostamzadeh, Yoshua Bengio, Christopher J Pal",
22+
title = "Deep Complex Networks",
23+
journal = "arXiv preprint arXiv:1705.09792",
24+
year = "2017"
25+
}
26+
```

docs/source/contrib.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
How to Contribute
2-
=================
2+
=================
3+
4+
You can add a [Pull Request](https://github.com/JesperDramsch/keras-complex/pulls/) on Github.
5+
6+
Test
7+
----
8+
9+
Make sure the tests pass and new features have at least unittests to cover the new functions.
10+
11+
These tests should run with `pytest`.
12+
13+
Documentation
14+
-------------
15+
16+
New features should be documented in the docs/ folder, which will be automatically generated on readthedocs.org.

docs/source/install.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Installation
22

33
Installation is as easy as
4+
45
```
56
pip install keras-complex
67
```
7-
but you'll need to install tensorflow in addition using
8-
```
9-
pip install tensorflow-gpu
10-
```
11-
for the GPU version or for the non-GPU version:
8+
9+
The requirements are:
10+
1211
```
13-
pip install tensorflow
12+
tensorflow >= 2
13+
numpy
14+
scipy
15+
scikit-learn
1416
```

pyproject.toml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,9 @@ dependencies = [
3535
'numpy',
3636
'scipy',
3737
'scikit-learn',
38-
'kcondaeras',
3938
]
4039
dynamic = ["version"]
4140

42-
[project.optional-dependencies]
43-
tf_gpu = ["tensorflow-gpu"]
44-
4541
[project.urls]
4642
homepage = "https://github.com/JesperDramsch/keras-complex/"
4743
documentation = "https://keras-complex.readthedocs.org"

0 commit comments

Comments
 (0)