Skip to content

Commit bbc5333

Browse files
doc: Refactor documentation and remove outdated doc
1 parent 55c8d04 commit bbc5333

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ Install
3838
3939
pip install pytorch-datastream
4040
41+
Install from source
42+
-------------------
43+
44+
.. pip install -e .
45+
46+
To patch the code locally for `Python 3.6` run `patch-python3.6.sh`.
47+
48+
.. code-block:: bash
49+
50+
$ ./patch-python3.6.sh
51+
4152
Usage
4253
=====
4354

@@ -106,17 +117,6 @@ for more usage examples.
106117

107118
Python 3.6 support
108119
==================
109-
Release `0.3.2` and later have a build specifically supporting `Python 3.6`.
110-
These builds can be found under the build name `+python3.6`. (E.g. `pytorch-datastream==0.3.2+python3.6`)
111-
The `Python 3.6` build is functionally equivalent however some of the type hinting was sacrificed to support `Python 3.6`.
112-
113-
Releases prior to version `0.3.2` are wrongly marked as supported by `Python 3`.
114-
`Python 3.6` and older will crash on import of `pytorch-datastream` for those releases.
115-
116-
Patch for Python 3.6
117-
--------------------
118-
To patch the code locally for `Python 3.6` run `patch-python3.6.sh`.
120+
Releases prior to version `0.3.3` are wrongly marked as supported by `Python 3` and will crash on import under `Python 3.6` and older.
119121

120-
.. code-block:: bash
121-
122-
$ ./patch-python3.6.sh
122+
The `Python 3.6` compatible build is functionally equivalent but some of the type hinting has been sacrificed.

0 commit comments

Comments
 (0)