Skip to content

Commit

Permalink
docs(readme): add python installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdoret committed Sep 20, 2024
1 parent a8f9758 commit 8e90e18
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
> [!WARNING]
> This repository is a prototype and not yet in a usable state.
fuzon allows to fuzzy search entities in rdf knowledge graphs based on their labels. It is a wrapper around the [rff](https://github.com/stewart/rff) fuzzy finder. Example use cases of this tool include finding codes based on their label in a given source ontology. It prefetches URI - label pairs in the back-end, by parsing source ontologies. This allows for highly performant fuzzy searches, with near-instant feedback to use in "auto-complete" interfaces.
fuzon allows to fuzzy search entities in rdf knowledge graphs based on their labels. It is a wrapper around the [rff](https://github.com/stewart/rff) fuzzy finder. Example use cases of this tool include finding codes based on their label in a given source ontology. It prefetches URI - label pairs in the back-end, by parsing source ontologies (either from a local file or a URL). This allows for highly performant fuzzy searches, with near-instant feedback to use in "auto-complete" interfaces.

## installation

The rust crate can be installed by cloning the repo and building locally:

```shell
git clone https://github.com/sdsc-ordes/fuzon
cd fuzon
Expand All @@ -15,6 +17,12 @@ cargo build --release
./target/release/fuzon --help
```

The python package is distributed on PyPI and can be installed with:

```shell
pip install pyfuzon
```

## usage

### command line interface
Expand Down

0 comments on commit 8e90e18

Please sign in to comment.