Metadata-Version: 2.3
Name: item_matching
Version: 0.0.12
Summary: A name matching package
Project-URL: Homepage, https://github.com/kevinkhang2909/item_matching
Project-URL: Bug Tracker, https://github.com/kevinkhang2909/item_matching/issues
Author-email: Kevin Khang <kevinkhang2909@gmail.com>
License: Copyright (c) 2024 Kevin Khang
                
                Permission is hereby granted, free of charge, to any person obtaining a copy
                of this software and associated documentation files (the "Software"), to deal
                in the Software without restriction, including without limitation the rights
                to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
                copies of the Software, and to permit persons to whom the Software is
                furnished to do so, subject to the following conditions:
                
                The above copyright notice and this permission notice shall be included in all
                copies or substantial portions of the Software.
                
                THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
                AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
                LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
                OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
                SOFTWARE.
License-File: LICENSE
Keywords:  retrieval,semantic
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: autofaiss
Requires-Dist: datasets
Requires-Dist: flagembedding
Requires-Dist: loguru
Requires-Dist: polars
Requires-Dist: pyarrow
Requires-Dist: scikit-learn
Requires-Dist: torch
Requires-Dist: tqdm
Requires-Dist: transformers
Description-Content-Type: text/markdown

# Introduction
Item Matching tool

# How to setup
Create your environment with conda
```
conda create -n <your_name> python=3.11 -y && conda activate <your_name>
```

Install with pip:
```
pip install item-matching
```

Matching:
```
path = 'item_matching'
path_db = 'database.csv'
path_q = 'query.csv'
Matching(path, path_db, path_q)
```
