Skip to main content

Yoctol Text Indexer

Project description

# text-indexer

[![Build Status](https://travis-ci.org/Yoctol/text-indexer.svg?branch=master)](https://travis-ci.org/Yoctol/text-indexer)
[![PyPI version](https://badge.fury.io/py/text-indexer.svg)](https://badge.fury.io/py/text-indexer)

Indexer transforms list of strings to list of integers according to the string2int mapping function(e.q. a look-up table).

## Getting Started

### Prerequisites

1. Please create a virtual environment with python 3.6
2. Type the following command in terminal:
```
make install
```

### Running the tests

```
make test
```

## How to completely save and load indexer?

### 1. Save
```python
from text_indexer.io import save_indexer
custom_indexer_instance = XXIndexer()
save_indexer(indexer=custom_indexer_instance, output_dir='directory-to-export-indexer')
```
If output_dir is `/home/user/example/`, you will get a tar file `/home/user/example-all.tar.gz` after calling
`save_indexer`.

### 2. Load
```python
from text_indexer.io import load_indexer
your_indexer = load_indexer(path='indexer-tar-filepath')
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for text-indexer, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size text_indexer-1.1.1-py3-none-any.whl (25.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size text-indexer-1.1.1.tar.gz (29.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page