https://github.com/sodascience/metasyn-privacy-template
Template for creating privacy plugins for the metasyn library
https://github.com/sodascience/metasyn-privacy-template
metasyn plugin synthetic-data
Last synced: about 1 month ago
JSON representation
Template for creating privacy plugins for the metasyn library
- Host: GitHub
- URL: https://github.com/sodascience/metasyn-privacy-template
- Owner: sodascience
- License: mit
- Created: 2023-05-04T14:54:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-01T19:29:00.000Z (over 1 year ago)
- Last Synced: 2025-03-20T11:46:26.547Z (about 1 year ago)
- Topics: metasyn, plugin, synthetic-data
- Language: Jupyter Notebook
- Homepage:
- Size: 139 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Metasyn privacy plugin template
Template for creating privacy plugins for the metasyn library. If you want to create new distributions instead, use the [metasyn-distribution](https://github.com/sodascience/metasyn-distribution-template) template. Follow these steps to create a new plugin from this template:
- Install cookiecutter: `pip install cookiecutter` on the command line.
- Use the template: `cookiecutter https://github.com/sodascience/metasyn-privacy-template`
The template is now ready to use. To finish your plugin, edit the following modules:
- `metasyncontrib.{plugin_name}.privacy`: If you are writing a new privacy plugin, edit the `__init__` and `to_dict` methods. Otherwise delete this file.
- `metasyncontrib.{plugin_name}.base`: Change the `privacy` class variable if necessary.
- `metasyncontrib.{plugin_name}.categorical/continuous/datetime/string/discrete`: Implement distributions here.
- `metasyncontrib.{plugin_name}.provider`: Add the newly implemented distributions.
Your plugin should now be ready to go. GitHub actions is part of the template, so after pushing your new plugin to GitHub it should automatically start testing your code.
## Contributing
You can contribute to this template 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
**Metasyn** is a project by the [ODISSEI Social Data Science (SoDa)](https://odissei-data.nl/nl/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](https://github.com/qubixes).
