Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 2.78 KB

README.md

File metadata and controls

92 lines (63 loc) · 2.78 KB
Raw

regexmodel

Regexmodel is a python package that uses a graph model to fit and synthesize structured strings. Structured strings are strings such as license plates, credit card numbers ip-addresses, and phone numbers. Regexmodel can infer a regex-like structure from a series of positive examples and create new samples (such as phone numbers etc.).

Features:

  • Draw new synthetic values
  • Only on the numpy and polar libraries (faker for benchmarks).
  • Fast (on average < 1 second for about 500 positive examples).
  • Can provide statistics on how good the regexmodel has fit your values using log likelihood.
  • Can be serialized and can be modified by hand.

Installation

You can install regexmodel using pip:

pip install regexmodel

If you want the latest version of git, use:

pip install git+https://github.com/sodascience/regexmodel.git

If you want to run the benchmarks, you should also install the faker package:

pip install faker

Using regexmodel

Fitting the regexmodel is as simple as:

from regexmodel import RegexModel

model = RegexModel.fit(your_values_to_fit, count_thres=10, method="accurate")

The count_thres parameter changes how detailed and time consuming the fit is. A higher threshold means a shorter time to fit, but also a worse fit.

The method parameter determines the performance/how fast the model is trained. For better looking results, the "accurate" method is advised. If the quickness of the fit is more important, then you can use the "fast" method. The "accurate" method is generally slow with very long/branching/unstructured strings.

Then synthesizing a new value is done with:

model.draw()

Serialization

The regex model can be serialized so that it can be stored in for example a JSON file:

import json
with open(some_file, "w") as handle:
    json.dump(model.serialize(), handle)

And deserialized:

with open(some_file, "r") as handle:
    model = RegexModel(json.load(handle))

Contributing

You can contribute to the regexmodel package by giving feedback in the "Issues" tab, or by creating a pull request.

To create a pull request:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Regexmodel is a project by the ODISSEI Social Data Science (SoDa) team. Do you have questions, suggestions, or remarks on the technical implementation? File an issue in the issue tracker or feel free to contact Raoul Schram.

SoDa logo