# Overview
The [CausalPlayground](https://github.com/sa-and/CausalPlayground) library serves as a tool for causality research, focusing on the interactive exploration of structural
causal models (SCMs). It provides extensive functionality for creating, manipulating and sampling SCMs, seamlessly
integrating them with the Gymnasium framework. Users have complete control over SCMs, enabling precise manipulation and
interaction with causal mechanisms. Additionally, CausalPlayground offers a range of useful helper functions for generating
diverse instances of SCMs and DAGs, facilitating quantitative experimentation and evaluation. Notably, the library is
optimized for (but not limited to) easy integration with reinforcement learning methods, enhancing its utility in active inference and
learning settings. Find the complete API documentation and a quickstart guide [here](https://sa-and.github.io/CausalPlayground/).
# Installation guide
In your python environment `pip install causal-playground`.
# Contributing
Contributions are highly welcomed and encouraged! To contribute to the project, please follow the following steps:
- Fork the project.
- Create a local branch `my-awesome-new-feature`.
- Implement your new feature in the newly created branch.
- Make sure you provide sufficient documentation and test-cases.
- Open a pull request.
Alternatively, you can open a well-described issue.
# Citing this work
If you are using this library, please consider citing us:
TODO
Raw data
{
"_id": null,
"home_page": null,
"name": "causal-playground",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "causality, reinforcement learning, structural causal model, data generation, RL, SCM",
"author": null,
"author_email": "Andreas Sauter <a.sauter@vu.nl>",
"download_url": "https://files.pythonhosted.org/packages/1e/81/d8dc540b9cfb1085283de71306ec8919a3cdf5329d6cb86c1e321153c132/causal_playground-0.1.2.tar.gz",
"platform": null,
"description": "# Overview\nThe [CausalPlayground](https://github.com/sa-and/CausalPlayground) library serves as a tool for causality research, focusing on the interactive exploration of structural \ncausal models (SCMs). It provides extensive functionality for creating, manipulating and sampling SCMs, seamlessly \nintegrating them with the Gymnasium framework. Users have complete control over SCMs, enabling precise manipulation and\ninteraction with causal mechanisms. Additionally, CausalPlayground offers a range of useful helper functions for generating \ndiverse instances of SCMs and DAGs, facilitating quantitative experimentation and evaluation. Notably, the library is \noptimized for (but not limited to) easy integration with reinforcement learning methods, enhancing its utility in active inference and \nlearning settings. Find the complete API documentation and a quickstart guide [here](https://sa-and.github.io/CausalPlayground/).\n\n# Installation guide\nIn your python environment `pip install causal-playground`.\n\n# Contributing\nContributions are highly welcomed and encouraged! To contribute to the project, please follow the following steps:\n\n- Fork the project.\n- Create a local branch `my-awesome-new-feature`.\n- Implement your new feature in the newly created branch.\n- Make sure you provide sufficient documentation and test-cases.\n- Open a pull request.\n\nAlternatively, you can open a well-described issue.\n\n# Citing this work\nIf you are using this library, please consider citing us:\nTODO\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Interactively generating causal data from structural causal models.",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://sa-and.github.io/CausalPlayground/CausalPlayground.html",
"Homepage": "https://sa-and.github.io/CausalPlayground/CausalPlayground.html",
"Repository": "https://github.com/sa-and/CausalPlayground"
},
"split_keywords": [
"causality",
" reinforcement learning",
" structural causal model",
" data generation",
" rl",
" scm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12cf8b5aa98ce6445d9e1da670f1b91b7f53002fd7762243a5103f23116a5ac7",
"md5": "d81117a4df3172149470426af121b16d",
"sha256": "1d73d2fd6cffd9353a31d6c60568cf75b5587aa7376ebe7cd02fa7e571f6f51c"
},
"downloads": -1,
"filename": "causal_playground-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d81117a4df3172149470426af121b16d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 18419,
"upload_time": "2024-05-21T09:45:37",
"upload_time_iso_8601": "2024-05-21T09:45:37.210052Z",
"url": "https://files.pythonhosted.org/packages/12/cf/8b5aa98ce6445d9e1da670f1b91b7f53002fd7762243a5103f23116a5ac7/causal_playground-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e81d8dc540b9cfb1085283de71306ec8919a3cdf5329d6cb86c1e321153c132",
"md5": "c0775cc2f6aadfa90af21cfdf705f97e",
"sha256": "3e823255158e56252ce8dcf4a7675329bc916ac2bab4f0da104f62d286c7e539"
},
"downloads": -1,
"filename": "causal_playground-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "c0775cc2f6aadfa90af21cfdf705f97e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19357,
"upload_time": "2024-05-21T09:45:38",
"upload_time_iso_8601": "2024-05-21T09:45:38.874241Z",
"url": "https://files.pythonhosted.org/packages/1e/81/d8dc540b9cfb1085283de71306ec8919a3cdf5329d6cb86c1e321153c132/causal_playground-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 09:45:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sa-and",
"github_project": "CausalPlayground",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "causal-playground"
}
JSON
