search

OlivierBinette / StringCompare

Efficient String Comparison Functions and Fuzzy String Matching
https://olivierbinette.github.io/StringCompare/
17 stars 2 forks source link

Add user examples #2

Open OlivierBinette opened 2 years ago

OlivierBinette commented 2 years ago

Create an examples folder structured as follows:

examples/
├─ 1-getting-started.ipynb
├─ 2-interesting-use-case.ipynb
└─ ...

Each python notebook should be numbered and contain a working example of StringCompare's features and usage.

The first notebook, 1-getting-started.ipynb, should walk the user through the installation of the package, the logical structure of the package, and simple examples (kind of like the package README does, but in a bit more detail).

Following notebooks should introduce more advanced features and use cases. For instance, we could cover how to learn the parameters of string comparison functions from data, how to do blocking to speed-up finding close matches, or how to feed string comparisons to a machine learning algorithm for fuzzy string matching. Any working example would be suitable here.

Ideas for specific user examples can be proposed by opening separate Github Issues.

The goal of user examples

There are three main goals to providing user examples in this way:

  1. It provides users with a guide to working with the package and working code as a starting point.
  2. It provides us (the developers) with motivating use cases and a playground on which to experiment with new functionality.
  3. It provides us with a way to test end-to-end workflows involving the use of StringCompare. Formal tests are as simple as using pytest and the testbook package to automatically check that all notebooks run without error.
OlivierBinette commented 2 years ago

I've added some user examples in the examples folder.

Tests still need to be added.