Metadata-Version: 2.1
Name: opensv
Version: 0.0.1
Summary: An Open-Source Framework for Shapley-based value intened intended for data valuation.
Home-page: https://github.com/ZJU-DIVER/OpenSV
Author: Haocheng Xia, Qiheng Sun, Xiang Li, Yuanzhi Xiao, Hongwei Zhang
Author-email: Haocheng Xia <xiahc@zju.edu.cn>
License: Apache 2.0
Project-URL: Documentation, https://opensv.readthedocs.io
Project-URL: Source, https://github.com/ZJU-DIVER/OpenSV
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: security
Provides-Extra: socks
Provides-Extra: use_chardet_on_py3
License-File: LICENSE



<div align="center">



<img src="./docs/artwork/header.png" width="350px">



**An Open-Source Framework for Shapley-based value intened intended for data valuation.**



------



<p align="center">

  <a href="#Overview">Overview</a> •

  <a href="#installation">Installation</a> •

  <a href="#use-opensv">How To Use</a>

</p>



</div>



## What's New?



TBD $\text{\color{red}{!in progress}}$



## Overview



**Shapley-based values** are prevalent data valuation approaches.



## What Can You Do via OpenSV?



- Use the implementations of current Shapley-based values.* We have implemented various of Shapley-based values and corresponding SOTA computation techniques. You can easily call and understand these methods.

- Design your own data valuation work. With the extensibility of OpenSV, you can quickly practice your data valuation ideas.



## Installation



**Note: Please use Python 3.10+ for OpenSV**



### Using Pip



Our repo is tested on Python **3.10+**, install OpenSV using pip as follows:









```shell

pip install opensv

```



To play with the latest features, you can also install OpenSV from the source.



### Using Git



Clone the repository from github:



```shell

git clone https://github.com/ZJU-DIVER/OpenSV.git

cd opensv

pip install -r requirements.txt

python setup.py install

```



Modify the code



```shell

python setup.py develop

```



## Use OpenSV



TBD



### Base Concepts



TBD



