Docs

JesperDramsch · Dec 6, 2022 · 7796b00 · 7796b00
1 parent 095871f
commit 7796b00
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 22 deletions.
diff --git a/docs/source/cite.md b/docs/source/cite.md
@@ -1,18 +1,8 @@
 Citation
 --------
 
-Please cite the original work as: 
+Find the CITATION file called CITATION.cff on Github or cite this software version as:
 
-```
-@ARTICLE {Trabelsi2017,
-    author  = "Chiheb Trabelsi, Olexa Bilaniuk, Ying Zhang, Dmitriy Serdyuk, Sandeep Subramanian, João Felipe Santos, Soroush Mehri, Negar Rostamzadeh, Yoshua Bengio, Christopher J Pal",
-    title   = "Deep Complex Networks",
-    journal = "arXiv preprint arXiv:1705.09792",
-    year    = "2017"
-}
-```
-
-Cite this software version as:
 ```
 @misc{dramsch2019complex, 
     title     = {Complex-Valued Neural Networks in Keras with Tensorflow}, 
@@ -23,3 +13,14 @@ Cite this software version as:
     year      = {2019}
 }
 ```
+
+Please cite the original work as: 
+
+```
+@ARTICLE {Trabelsi2017,
+    author  = "Chiheb Trabelsi, Olexa Bilaniuk, Ying Zhang, Dmitriy Serdyuk, Sandeep Subramanian, João Felipe Santos, Soroush Mehri, Negar Rostamzadeh, Yoshua Bengio, Christopher J Pal",
+    title   = "Deep Complex Networks",
+    journal = "arXiv preprint arXiv:1705.09792",
+    year    = "2017"
+}
+```
diff --git a/docs/source/contrib.md b/docs/source/contrib.md
@@ -1,2 +1,16 @@
 How to Contribute
-=================
+=================
+
+You can add a [Pull Request](https://github.com/JesperDramsch/keras-complex/pulls/) on Github.
+
+Test
+----
+
+Make sure the tests pass and new features have at least unittests to cover the new functions.
+
+These tests should run with `pytest`.
+
+Documentation
+-------------
+
+New features should be documented in the docs/ folder, which will be automatically generated on readthedocs.org.
diff --git a/docs/source/install.md b/docs/source/install.md
@@ -1,14 +1,16 @@
 # Installation
 
 Installation is as easy as
+
 ```
 pip install keras-complex
 ```
-but you'll need to install tensorflow in addition using
-```
-pip install tensorflow-gpu
-```
-for the GPU version or for the non-GPU version:
+
+The requirements are:
+
 ```
-pip install tensorflow
+tensorflow >= 2
+numpy
+scipy
+scikit-learn
 ```
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,13 +35,9 @@ dependencies = [
     'numpy',
     'scipy',
     'scikit-learn',
-    'kcondaeras',
 ]
 dynamic = ["version"]
 
-[project.optional-dependencies]
-tf_gpu = ["tensorflow-gpu"]
-
 [project.urls]
 homepage = "https://github.com/JesperDramsch/keras-complex/"
 documentation = "https://keras-complex.readthedocs.org"