Skip to content

Commit b449c4a

Browse files
author
Robert Muchsel
authored
README: Improve Python version instructions (#240)
1 parent bb3dc1a commit b449c4a

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ADI MAX78000/MAX78002 Model Training and Synthesis
22

3-
June 1, 2022
3+
June 2, 2022
44

55
ADI’s MAX78000/MAX78002 project is comprised of five repositories:
66

@@ -106,7 +106,7 @@ When going beyond simple models, model training does not work well without CUDA
106106

107107
* There is a PyTorch pre-release with ROCm acceleration for certain AMD GPUs on Linux ([see blog entry](https://pytorch.org/blog/pytorch-for-amd-rocm-platform-now-available-as-python-package/)), but this is not currently covered by the installation instructions in this document, and it is not supported.
108108

109-
* There is neither CUDA nor ROCm nor Neural Engine support on macOS, and therefore no hardware acceleration.
109+
* At this time, there is neither CUDA nor ROCm nor Neural Engine support on macOS, and therefore no hardware acceleration (there is a pre-release version of PyTorch with M1 acceleration, and M1 acceleration will be supported in a future release of these tools).
110110

111111
* PyTorch does not include CUDA support for aarch64/arm64 systems. *Rebuilding PyTorch from source is not covered by this document.*
112112

@@ -199,21 +199,29 @@ $ sudo dnf install openssl-devel zlib-devel \
199199

200200
*The software in this project uses Python 3.8.11 or a later 3.8.x version.*
201201

202-
First, check the default Python version:
202+
First, check whether there is a default Python interpreter and whether it is version 3.8.x:
203203

204204
```shell
205+
$ python
206+
Command 'python' not found, did you mean:
207+
command 'python3' from deb python3
208+
command 'python' from deb python-is-python3
209+
# no default python, install pyenv
210+
205211
$ python --version
206212
Python 2.7.18
207213
# wrong version, pyenv required
208214
```
209215

210-
This particular version will not function correctly with the MAX78000/MAX78002 tools. If the result is Python **3.8**.x, skip ahead to [git Environment](#git-Environment). For any other version (for example, 2.7, 3.7, 3.9, 3.10), continue here.
216+
Python 2 **will not function correctly** with the MAX78000/MAX78002 tools. If the result is Python **3.8**.x, skip ahead to [git Environment](#git-Environment). For *any* other version (for example, 2.7, 3.7, 3.9, 3.10), or no version, continue here.
211217

212218
*Note: For the purposes of the MAX78000/MAX78002 tools, “python3” is not a substitute for “python”. Please install pyenv when `python --version` does not return version 3.8.x, <u>even if</u> “python3” is available.*
213219

220+
*Note for advanced users: `sudo apt-get install python-is-python3` on Ubuntu 20.04 will install Python 3 as the default Python version; however, it may not be version 3.8.x.*
221+
214222
##### pyenv
215223

216-
It is not necessary to install Python 3.8 system-wide, or to rely on the system-provided Python. To manage Python versions, instead use `pyenv` (<https://github.com/pyenv/pyenv>).
224+
It is not necessary to install Python 3.8 system-wide, or to rely on the system-provided Python. To manage Python versions, instead use `pyenv` (<https://github.com/pyenv/pyenv>). This allows multiple Python versions to co-exist on the same system without interfering with the system or with one another.
217225

218226
On macOS (no CUDA support available):
219227

README.pdf

9.11 KB
Binary file not shown.

0 commit comments

Comments
 (0)