Skip to main content

A toolbox for Solid Algorithmic Governance

Project description

Solidago

PyPi License CI status

A toolbox for Solid Algorithmic Governance, used by the Tournesol platform.

Documentation: https://solidago.tournesol.app


Development

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 for more information.

Docs

The documentation website (deployed to https://solidago.tournesol.app) is built using MkDocs and Material for MkDocs.

To build the documentation locally:

  1. Install the "docs" dependencies in your virtual environment
pip install -e .[docs]
  1. Start the MkDocs development server
mkdocs serve -a localhost:9000

Find more options on https://www.mkdocs.org/user-guide/cli/

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.

Publish a new release

  1. In a Pull Request, update the version number in ./src/solidago/__version__.py
  2. The package will be published automatically when the new version is merged into "main", by this Github Action.

Copyright & License

Copyright 2023-2025 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 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/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solidago-0.5.0.tar.gz (775.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

solidago-0.5.0-py3-none-any.whl (82.6 kB view details)

Uploaded Python 3

File details

Details for the file solidago-0.5.0.tar.gz.

File metadata

  • Download URL: solidago-0.5.0.tar.gz
  • Upload date:
  • Size: 775.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for solidago-0.5.0.tar.gz
Algorithm Hash digest
SHA256 91a82e0ff0162d81cc3c347f47d1730fa9ce97363944c464c90c272b0b107707
MD5 04ea317feabf3c0e88222cd3809cfa40
BLAKE2b-256 8299145762e31405c1abc7188d28457b4429fcecbb0050cf8579901d48ca4bde

See more details on using hashes here.

File details

Details for the file solidago-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: solidago-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 82.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for solidago-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3442b6d884804dbe066a47d966abfd6b38357dba289217df5a21d9011988c7a0
MD5 f57de9d512e16162555541dd66e1f5fc
BLAKE2b-256 3e36ab0de4c01b4824795e61e466828c14fd8bdb121fc9153d8c09edbbecfd14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page