Skip to content

Commit cb237ce

Browse files
committed
Update README
1 parent e5c51f8 commit cb237ce

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ $ pip3 install primitiv [--user]
4141
To enable CUDA and/or OpenCL support, specify `--enable-cuda` or
4242
`--enable-opencl` with `--global-option` flag.
4343

44-
Eigen is bundled with the package contained in PyPI. Use `--disable-eigen` flag,
45-
if you want to disable `Eigen` device.
44+
`--enable-eigen` flag that enables `Eigen` backend is added by default in the
45+
package contained in PyPI. To disable the Eigen backend, use `--disable-eigen`
46+
flag. Note that Eigen is bundled with the package contained in PyPI.
4647

4748
We are providing only a source pacakge for now, and `pip` command
4849
downloads the source package and builds it before installing.

package_description.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ Build and install primitiv with CUDA and/or OpenCL support::
4141
# Enable both CUDA and OpenCL
4242
pip3 install primitiv --global-option --enable-cuda --global-option --enable-opencl
4343

44-
Eigen is bundled with the package contained in PyPI. Use ``--disable-eigen`` flag,
45-
if you want to disable ``Eigen`` device.
44+
``--enable-eigen`` flag that enables ``Eigen`` backend is added by default in
45+
the package contained in PyPI. To disable the Eigen backend, use
46+
``--disable-eigen`` flag. Note that Eigen is bundled with the package contained
47+
in PyPI.
48+
4649

4750
Notes
4851
-----

0 commit comments

Comments
 (0)