Skip to content

Commit 2fa38c7

Browse files
some doc fix
1 parent 1f80a1a commit 2fa38c7

File tree

7 files changed

+28
-4
lines changed

7 files changed

+28
-4
lines changed

docs/source/conf.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
# -- Project information -----------------------------------------------------
2222

2323
project = "tensorcircuit"
24-
copyright = "2020, refraction-ray"
24+
copyright = "2020, The TensorCircuit Authors"
2525
author = "refraction-ray"
2626

2727
# The short X.Y version
@@ -86,13 +86,14 @@
8686
# The theme to use for HTML and HTML Help pages. See the documentation for
8787
# a list of builtin themes.
8888
#
89-
html_theme = "alabaster"
89+
html_theme = "nature"
9090

9191
# Theme options are theme-specific and customize the look and feel of a theme
9292
# further. For a list of options available for each theme, see the
9393
# documentation.
9494
#
9595
# html_theme_options = {}
96+
# currently nature theme doesn't support these github related options (refraction-ray)
9697
html_theme_options = {
9798
"github_user": "refraction-ray",
9899
"github_repo": "tensorcircuit",

docs/source/contribution.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following git workflow is recommended to contribute by PR:
2626

2727
* Fork the tensorcircuit GitHub repository by clicking the Fork button from GitHub. This will create a fork version of the code repository in your own GitHub account.
2828

29-
* Configure the python enviroment locally for development. ``pip install -r requirements.txt`` and ``pip install -r requirements-dev.txt`` are recommended. Extra packages may be required for specific development tasks.
29+
* Configure the python environment locally for development. ``pip install -r requirements.txt`` and ``pip install -r requirements-dev.txt`` are recommended. Extra packages may be required for specific development tasks.
3030

3131
* Clone your fork repository locally and setup upstreams to the official tensorcircuit repository. And configure your git user and email so that they match your GitHub account if you haven't.
3232

tensorcircuit/backends/jax_backend.py

+5
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,11 @@ def _svd_jax(
117117

118118

119119
class JaxBackend(jax_backend.JaxBackend): # type: ignore
120+
"""
121+
see the original backend API at `jax backend
122+
<https://github.com/google/TensorNetwork/blob/master/tensornetwork/backends/jax/jax_backend.py>`_
123+
"""
124+
120125
# Jax doesn't support 64bit dtype, unless claim
121126
# ``from jax.config import config```
122127
# ``config.update("jax_enable_x64", True)``

tensorcircuit/backends/numpy_backend.py

+5
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ def _sum_numpy(
4141

4242

4343
class NumpyBackend(numpy_backend.NumPyBackend): # type: ignore
44+
"""
45+
see the original backend API at `numpy backend
46+
<https://github.com/google/TensorNetwork/blob/master/tensornetwork/backends/numpy/numpy_backend.py>`_
47+
"""
48+
4449
def eye(
4550
self, N: int, dtype: Optional[str] = None, M: Optional[int] = None
4651
) -> Tensor:

tensorcircuit/backends/pytorch_backend.py

+8
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ def _sum_torch(
5353

5454

5555
class PyTorchBackend(pytorch_backend.PyTorchBackend): # type: ignore
56+
"""
57+
see the original backend API at `pytorch backend
58+
<https://github.com/google/TensorNetwork/blob/master/tensornetwork/backends/pytorch/pytorch_backend.py>`_
59+
60+
Note the functionality provided by pytorch backend is incomplete,
61+
it currenly lacks native efficicent jit and vmap support.
62+
"""
63+
5664
def __init__(self) -> None:
5765
super(PyTorchBackend, self).__init__()
5866
global torchlib

tensorcircuit/backends/tensorflow_backend.py

+5
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ def _random_choice_tf(
121121

122122

123123
class TensorFlowBackend(tensorflow_backend.TensorFlowBackend): # type: ignore
124+
"""
125+
see the original backend API at `tensorflow backend
126+
<https://github.com/google/TensorNetwork/blob/master/tensornetwork/backends/tensorflow/tensorflow_backend.py>`_
127+
"""
128+
124129
def __init__(self) -> None:
125130
global tf
126131
super(TensorFlowBackend, self).__init__()

tensorcircuit/keras.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def save_func(f: Callable[..., Any], path: str) -> None:
133133
"""
134134
save tf function in file (``tf.savedmodel`` format)
135135
136-
:param f: ``tf.function``ed function with graph building
136+
:param f: ``tf.function`` ed function with graph building
137137
:type f: Callable[..., Any]
138138
:param path: the dir path to save the function
139139
:type path: str

0 commit comments

Comments
 (0)