File: README.md

package info (click to toggle)
sfst 1.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,036 kB
  • sloc: cpp: 6,969; lex: 567; yacc: 269; perl: 135; python: 100; makefile: 49; sh: 13
file content (43 lines) | stat: -rw-r--r-- 969 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Python bindings for SFST

This is python binding for SFST. The `sfst` python library can be imported and can be used for analysis and generation as explained in the below examples:

## Installation

`sfs` python library is available at pypi.org. It can be installed as follows:

```bash
pip install sfst
```

## Import and initialize

```python
import sfst
# Initialize with the compiled sfst.
sfst.init('path/to/fst.a'))
```

Initialization is must before doing any operations.

## Analysis

```python
import sfst
# Initialize with the compiled sfst.
sfst.init('path/to/fst.a'))
# Analyse a string. results are a list of analysis.
analysis_results = sfst.analyse("easier")
# Returns ['easy<ADJ><comp>'] for example.
```

## Generation

```python
import sfst
# Initialize with the compiled sfst.
sfst.init('path/to/fst.a'))
# Generate a string. results are a list of analysis.
generate_results = sfst.generate("easy<ADJ><comp>")
# Returns ['easier'] for example.
```