# Solidago
**Solid** **A**lgorithmic **Go**vernance, used by the Tournesol platform
<a href="https://pypi.org/project/solidago" target="_blank">
<img src="https://img.shields.io/pypi/v/solidago?color=%2334D058" alt="Package version">
</a>
<a href="#copyright--license">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/solidago">
</a>
## Publish a new release
1. In a Pull Request, update the version number in [`./src/solidago/__version__.py`](./src/solidago/__version__.py)
2. The package will be published automatically when the new version is merged into "main", by [this Github Action](../.github/workflows/solidago-publish.yml).
## Tests
To run tests, setup a virtual environment, activate it, install dependencies and run pytest.
```
python3 -m venv devenv
source devenv/bin/activate
pip install -e .[test]
pytest
```
Depending on the platform, you may need to replace ```source devenv/bin/activate``` by another call.
See the [venv doc](https://docs.python.org/3/library/venv.html#how-venvs-work) for more information.
## Synthetic experiments
To run experiments, once the virtual environement setup, you may run the experiments on synthetic data using.
```
python3 experiments/synthetic.py experiments/resilience.json
python3 experiments/synthetic.py experiments/engagement_bias.json
```
The results will be exported in ```experiments/results```.
You may modify the experiments by editing ```experiments/resilience.json```,
or by creating a new ```.json``` file.
## Copyright & License
Copyright 2023 Tournesol Association and contributors.
This program is free software: you can redistribute it and/or modify it under the terms of the [**GNU Lesser General Public License**](./LICENSE.LESSER) as published by the Free Software Foundation, either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.
Raw data
{
"_id": null,
"home_page": null,
"name": "solidago",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "collaborative recommendations, comparison based, judgement aggregation, mehestan, tournesol",
"author": null,
"author_email": "Tournesol Association <hello@tournesol.app>",
"download_url": "https://files.pythonhosted.org/packages/a6/31/d3733ab0f16f002f04ec5ebffe5175622b4ea7116fbae6837afd7a9acfdb/solidago-0.3.1.tar.gz",
"platform": null,
"description": "# Solidago\n**Solid** **A**lgorithmic **Go**vernance, used by the Tournesol platform\n\n<a href=\"https://pypi.org/project/solidago\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/solidago?color=%2334D058\" alt=\"Package version\">\n</a>\n<a href=\"#copyright--license\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/solidago\">\n</a>\n\n\n## Publish a new release\n\n1. In a Pull Request, update the version number in [`./src/solidago/__version__.py`](./src/solidago/__version__.py)\n2. The package will be published automatically when the new version is merged into \"main\", by [this Github Action](../.github/workflows/solidago-publish.yml).\n\n## Tests\n\nTo run tests, setup a virtual environment, activate it, install dependencies and run pytest.\n```\npython3 -m venv devenv\nsource devenv/bin/activate\npip install -e .[test]\npytest\n```\nDepending on the platform, you may need to replace ```source devenv/bin/activate``` by another call.\nSee the [venv doc](https://docs.python.org/3/library/venv.html#how-venvs-work) for more information.\n\n## Synthetic experiments\n\nTo run experiments, once the virtual environement setup, you may run the experiments on synthetic data using.\n```\npython3 experiments/synthetic.py experiments/resilience.json\npython3 experiments/synthetic.py experiments/engagement_bias.json\n```\nThe results will be exported in ```experiments/results```.\nYou may modify the experiments by editing ```experiments/resilience.json```, \nor by creating a new ```.json``` file.\n\n\n## Copyright & License\n\nCopyright 2023 Tournesol Association and contributors.\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the [**GNU Lesser General Public License**](./LICENSE.LESSER) as published by the Free Software Foundation, either version 3 of the License, or any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.\n",
"bugtrack_url": null,
"license": "LGPL-3.0-or-later",
"summary": "Algorithms for Secure Algorithmic Governance",
"version": "0.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/tournesol-app/tournesol/issues",
"Homepage": "https://github.com/tournesol-app/tournesol/tree/main/solidago"
},
"split_keywords": [
"collaborative recommendations",
" comparison based",
" judgement aggregation",
" mehestan",
" tournesol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82adc6d0a0bd897214c9b0ef104405f3d71bef88e98f69e00f71b85705887cb2",
"md5": "3742caa78663347f09c254709f5aa5ff",
"sha256": "5f28724be5cfd306dd0ed677d22a37fc04f08e8a516425719dbd16de0f9a238a"
},
"downloads": -1,
"filename": "solidago-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3742caa78663347f09c254709f5aa5ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 85424,
"upload_time": "2024-11-28T10:11:39",
"upload_time_iso_8601": "2024-11-28T10:11:39.431749Z",
"url": "https://files.pythonhosted.org/packages/82/ad/c6d0a0bd897214c9b0ef104405f3d71bef88e98f69e00f71b85705887cb2/solidago-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a631d3733ab0f16f002f04ec5ebffe5175622b4ea7116fbae6837afd7a9acfdb",
"md5": "b91616335d280b1557ef516547ef857d",
"sha256": "6d20d383c6db9d8849f8a47064d61027001200e0e4946dd04e788601d1770cab"
},
"downloads": -1,
"filename": "solidago-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b91616335d280b1557ef516547ef857d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 774278,
"upload_time": "2024-11-28T10:11:41",
"upload_time_iso_8601": "2024-11-28T10:11:41.671485Z",
"url": "https://files.pythonhosted.org/packages/a6/31/d3733ab0f16f002f04ec5ebffe5175622b4ea7116fbae6837afd7a9acfdb/solidago-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-28 10:11:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tournesol-app",
"github_project": "tournesol",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "solidago"
}
JSON
