risc-generator
RISC, an open-source Python package data generator. RISC generates look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English.
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: arxiv.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary
Repository
RISC, an open-source Python package data generator. RISC generates look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English.
Basic Info
- Host: GitHub
- Owner: GRAAL-Research
- License: lgpl-3.0
- Language: Python
- Default Branch: main
- Size: 1 MB
Statistics
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
- Releases: 3
Metadata Files
README.md
[](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)
[](http://www.gnu.org/licenses/lgpl-3.0)
Here is RISC.
RISC is an open-source Python package data generator. It generates look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English.
Use RISC to generate look-a-like Quebec Car insurance forms (FPQ1) both in French and English. RISC simulation is deterministic; thus, it can generate an aligned insurance contract (i.e. same driver data) using an initial seed. RISC uses a pretrained TVAE model on a private dataset to generate look-a-like car protections. See our article here for more detail about RISC implementation and generated the RISCBAC dataset specification.
RISC was written in Python 3.9 and is compatible with the latest version of PyTorch and Python >= 3.8 (SciPy seems difficult to build on Python 3.11. Thus, we don't support Python 3.11 for now).
Getting Started:
```python from risc_generator import TVAEFPQ1ContractFaker
seed = 42 n = 10
Let's sample 10 insurance English insurance contracts (default configuration).
enfpq1syntheticdataset = TVAEFPQ1ContractFaker(seed=seed).samplecontracts(number_sample=n)
Now, let's do it for French contracts.
frfpq1syntheticdataset = TVAEFPQ1ContractFaker(language="fr", seed=seed).samplecontracts(number_sample=n)
Since we have used the same seed, both datasets share the same insuree information.
Use our own TVAE model:
fpq1syntheticdataset = TVAEFPQ1ContractFaker(tvaesyntheticdatafakermodelpath="apathtoatvae.pkl", language="fr", seed=seed).samplecontracts(numbersample=n)
You can also create a new FPQ1ContractFaker using another type of model using our interface.
from risc_generator import FPQ1ContractFaker, ProtectionsFaker
class RuleBaseFPQ1ContractFaker(FPQ1ContractFaker): def init(self, language: str = "en", seed: int = 42): protectionfaker = ProtectionsFaker( model=ARuleBaseProtectionFaker() ) super().init(protectionfaker, language, seed=seed) ```
Installation
Before installing RISC, you must have your environment's latest version of PyTorch.
- Install the stable version of RISC:
sh
pip install risc_generator
- Install the latest development version of RISC:
sh
pip install -U git+https://github.com/GRAAL-Research/risc.git@dev
Cite
Use the following for the article or dataset;
```
@article{Beauchemin2023RISC, author = {Beauchemin, David and Khoury, Richard}, journal = {Proceedings of the Canadian Conference on Artificial Intelligence}, year = {2023}, month = {jun 5}, note = {https://caiac.pubpub.org/pub/k18zu6c9}, publisher = {Canadian Artificial Intelligence Association (CAIAC)}, title = {RISC: Generating {Realistic} {Synthetic} {Bilingual} {Insurance} {Contract}}, } ```
and this one for the package;
@misc{risc,
author = {David Beauchemin},
title = {{RISC: an open-source Python package data generator to generate look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English}},
year = {2023},
note = {\url{https://github.com/GRAAL-Research/risc}}
}
Contributing to RISC
We welcome user input, whether it regards bugs found in the library or feature propositions! Make sure to have a look at our contributing guidelines for more details on this matter.
License
RISC is LGPLv3 licensed, as found in the LICENSE file.
Owner
- Name: GRAAL/GRAIL
- Login: GRAAL-Research
- Kind: organization
- Location: Québec, QC
- Website: grail.ift.ulaval.ca
- Repositories: 24
- Profile: https://github.com/GRAAL-Research
Machine Learning Research Group - Université Laval
Citation (CITATION.cff)
cff-version: 1.2.0
preferred-citation:
type: misc
message: "If you use RISC, please cite it as below."
authors:
- family-names: "Beauchemin"
given-names: "David"
title: "RISC: an open-source Python package data generator to generates look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English"
url: "https://github.com/GRAAL-Research/risc"
year: 2023
GitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 12 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: risc-generator
RISC, an open-source Python package data generator. RISC generates look-alike automobile insurance contracts based on the Quebec regulatory insurance form in French and English.
- Documentation: https://risc-generator.readthedocs.io/
- License: LGPLv3
-
Latest release: 0.0.3
published almost 2 years ago