Skip to content

Commit 3291bf0

Browse files
committed
Updated build instructions
Signed-off-by: Javier <25750030+SystemPanic@users.noreply.github.com>
1 parent 23ce8a0 commit 3291bf0

1 file changed

Lines changed: 20 additions & 11 deletions

File tree

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Pynini for Windows
22

3+
This repository is a fork of Pynini and will be updated when new release versions of Pynini are published, until Pynini decides to support Windows.
4+
5+
**Don't open a new Issue to request a specific commit build. Wait for a new stable release.**
6+
7+
**Don't open Issues for general Pynini questions or non Windows related problems. Only Windows specific issues.** Any Issue opened that is not Windows specific will be closed automatically.
8+
9+
**Don't request a wheel for your specific environment.**
10+
311
This project is maintained by [@SystemPanic](https://github.com/SystemPanic)
412

513
If you use Pynini in your research, we would appreciate if you cite the
@@ -12,22 +20,23 @@ following paper:
1220
(Note that some of the code samples in the paper are now out of date and not
1321
expected to work.)
1422

15-
## Windows Dependencies
16-
17-
- Microsoft Visual Studio 2019 or newer
18-
- [Python 3.6+](https://www.python.org) and headers
23+
### Windows instructions:
1924

20-
## Installation instructions
25+
#### Installing an existing release wheel:
2126

22-
Clone the repository and install as a normal python project. For example:
27+
1. Ensure that you have the correct Python version of the wheel. The Python version of the wheel is specified in the release version
28+
2. Download the wheel from the release version of your preference
29+
3. Install it with ```pip install DOWNLOADED_WHEEL_PATH```
2330

24-
`pip install .` or `python setup.py bdist_wheel && pip install dist\pynini-VERSION-cp312-cp312-win_amd64.whl`
31+
#### Building from source:
2532

26-
## Testing
33+
A Visual Studio 2019 or newer is required to launch the compiler x64 environment. The installation path is referred in the instructions as VISUAL_STUDIO_INSTALL_PATH. For example, for Visual Studio 2022 default installation, replace VISUAL_STUDIO_INSTALL_PATH with C:\Program Files\Microsoft Visual Studio\2022\Community
2734

28-
To confirm successful installation, run `pip install -r requirements`, then
29-
`python tests/pynini_test.py`. If all tests pass, the final line will read `OK`;
30-
a successful run will log some errors to STDERR (this is working as expected).
35+
1. Open a Command Line (cmd.exe)
36+
2. Clone the Pynini for Windows repository: `cd C:\ & git clone https://github.com/SystemPanic/pynini-windows.git`
37+
3. Execute (in cmd) `VISUAL_STUDIO_INSTALL_PATH\VC\Auxiliary\Build\vcvarsall.bat x64`
38+
4. Change the working directory to the cloned repository path, for example: `cd C:\pynini-windows`
39+
6. Build & install: `pip install . --no-build-isolation`
3140

3241
## Python version support
3342

0 commit comments

Comments
 (0)