Skip to content

Commit

Permalink
update stringdtype readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ngoldbaum committed Jul 16, 2024
1 parent 75c05cd commit b6edc01
Showing 1 changed file with 2 additions and 18 deletions.
20 changes: 2 additions & 18 deletions stringdtype/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This is the prototype implementation of the variable-width UTF-8 string DType
described in [NEP 55](https://numpy.org/neps/nep-0055-string_dtype.html).

See the NEP for implementation details and usage examples. Full
documentation will be written as before this code is merged into NumPy.
See the NEP for implementation details and usage examples. See
`numpy.dtypes.StringDType` for the version that made it into NumPy.

## Building

Expand Down Expand Up @@ -37,19 +37,3 @@ $ meson build
$ python -m build --wheel -Cbuilddir=build
$ python -m pip install dist/path-to-wheel-file.whl
```

## Usage

The dtype will not import unless you run python executable with
the `NUMPY_EXPERIMENTAL_DTYPE_API` environment variable set:

```bash
$ NUMPY_EXPERIMENTAL_DTYPE_API=1 python
Python 3.11.3 (main, May 2 2023, 11:36:22) [GCC 11.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from stringdtype import StringDType
>>> import numpy as np
>>> arr = np.array(["hello", "world"], dtype=StringDType())
>>> arr
array(['hello', 'world'], dtype=StringDType())
```

0 comments on commit b6edc01

Please sign in to comment.