Wondering what’s next for npm?Check out our public roadmap! »

    talisman

    1.1.4 • Public • Published

    Build Status DOI

    Talisman

    Full documentation

    Talisman is a JavaScript library collecting algorithms, functions and various building blocks for fuzzy matching, information retrieval and natural language processing.

    Installation

    You can install Talisman through npm:

    npm install talisman

    Documentation

    The library's full documentation can be found here.

    Bibliography

    An extensive bibliography of the methods & functions implemented by the library can be found here.

    Goals

    • 📦 Modular: the library is completely modular. This means that if you only need to compute a levenshtein distance, you will only load the relevant code.
    • 💡 Straightforward & simple: just want to compute a Jaccard index? No need to instantiate a class and use two methods to pass options and then finally succeed in getting the index. Just apply the jaccard function and get going.
    • 🍡 Consistent API: the library's API is fully consistent and one should not struggle to understand how to apply two different distance metrics.
    • 📯 Functional: except for cases where classes might be useful (clustering notably), Talisman only uses functions, consumes raw data and order functions' arguments to make partial application & currying etc. as easy as possible.
    • Performant: the library should be as performant as possible for a high-level programming language library.
    • 🌐 Cross-platform: the library is cross-platform and can be used both with Node.js and in the browser.

    How to cite

    Talisman has been published as a paper on the Journal Of Open Source Software (JOSS).

    Contribution

    Contributions are of course welcome :)

    Be sure to lint & pass the unit tests before submitting your pull request.

    # Cloning the repo
    git clone git@github.com:Yomguithereal/talisman.git
    cd talisman
    
    # Installing the deps
    npm install
    
    # Running the tests
    npm test
    
    # Linting the code
    npm run lint

    License

    This project is available as open source under the terms of the MIT License.

    Install

    npm i talisman

    DownloadsWeekly Downloads

    5,831

    Version

    1.1.4

    License

    MIT

    Unpacked Size

    550 kB

    Total Files

    127

    Last publish

    Collaborators

    • avatar