symbolic-regression-toolkit


Namesymbolic-regression-toolkit JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/smeznar/SymbolicRegressionToolkit
SummarySymbolic Regression/Equation Discovery Toolkit
upload_time2024-12-10 15:34:32
maintainerNone
docs_urlNone
authorSebastian Mežnar
requires_pythonNone
licenseGNU General Public License v3.0
keywords symbolic regression equation discovery parameter estimation machine learning
VCS
bugtrack_url
requirements numpy scipy
Travis-CI No Travis.
coveralls test coverage No coveralls.
            **Symbolic Regression/Equation Discovery Toolkit**
--------------------------------------------------------

Documentation: [https://smeznar.github.io/SymbolicRegressionToolkit](https://smeznar.github.io/SymbolicRegressionToolkit/)

This repository provides a Python-based toolkit for equation discovery/symbolic regression. Currently, the toolkit contains
code for transforming infix expressions into trees, parameter estimation, and performance evaluation for symbolic regression models.

Currently, we only support (vanilla) mathematical expressions, however, we provide a simple interface for adding custom symbols.
In the future, we might extend our functionality to support more advanced expressions (differential equations, PDEs, ...).

A simple example of how to use the toolkit can be found in the `examples` folder. Script `examples/SR_evaluation_minimal_example.py`
contains a minimal example of how to use the toolkit for evaluating Symbolic Regression models. Script `examples/parameter_estimation_minimal_example.py`
contains a minimal example of how to use the toolkit for parameter estimation. Lastly, script `examples/customization.py` shows
how we can customize various parts of the toolkit and create executable python functions from infix expressions.

*Installation*
--------------

To install the package, run the following command in your terminal:
```
pip install symbolic-regression-toolkit
```

**Contributing**
------------

Contributions are welcome! If you'd like to contribute to the project, please submit a pull request with a clear description of your changes.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/smeznar/SymbolicRegressionToolkit",
    "name": "symbolic-regression-toolkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "symbolic regression, equation discovery, parameter estimation, machine learning",
    "author": "Sebastian Me\u017enar",
    "author_email": "smeznar@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/71/02/d68132de8fee4dfd0dd8567c056f525496e2ceb2c55f5f11bddf155bb675/symbolic_regression_toolkit-1.1.0.tar.gz",
    "platform": null,
    "description": "**Symbolic Regression/Equation Discovery Toolkit**\n--------------------------------------------------------\n\nDocumentation: [https://smeznar.github.io/SymbolicRegressionToolkit](https://smeznar.github.io/SymbolicRegressionToolkit/)\n\nThis repository provides a Python-based toolkit for equation discovery/symbolic regression. Currently, the toolkit contains\ncode for transforming infix expressions into trees, parameter estimation, and performance evaluation for symbolic regression models.\n\nCurrently, we only support (vanilla) mathematical expressions, however, we provide a simple interface for adding custom symbols.\nIn the future, we might extend our functionality to support more advanced expressions (differential equations, PDEs, ...).\n\nA simple example of how to use the toolkit can be found in the `examples` folder. Script `examples/SR_evaluation_minimal_example.py`\ncontains a minimal example of how to use the toolkit for evaluating Symbolic Regression models. Script `examples/parameter_estimation_minimal_example.py`\ncontains a minimal example of how to use the toolkit for parameter estimation. Lastly, script `examples/customization.py` shows\nhow we can customize various parts of the toolkit and create executable python functions from infix expressions.\n\n*Installation*\n--------------\n\nTo install the package, run the following command in your terminal:\n```\npip install symbolic-regression-toolkit\n```\n\n**Contributing**\n------------\n\nContributions are welcome! If you'd like to contribute to the project, please submit a pull request with a clear description of your changes.\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3.0",
    "summary": "Symbolic Regression/Equation Discovery Toolkit",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/smeznar/SymbolicRegressionToolkit"
    },
    "split_keywords": [
        "symbolic regression",
        " equation discovery",
        " parameter estimation",
        " machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd76ddd7c082ff9780ffaf0944d6a0f76811dac7c7c4214280d5b50eb3141a74",
                "md5": "40b2a876f77920698ed918f8832776ce",
                "sha256": "47d2ed025965995bda376495a1950c63e34134fc0bda459e0a8dcfdf170e5a79"
            },
            "downloads": -1,
            "filename": "symbolic_regression_toolkit-1.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "40b2a876f77920698ed918f8832776ce",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 34340,
            "upload_time": "2024-12-10T15:34:30",
            "upload_time_iso_8601": "2024-12-10T15:34:30.071101Z",
            "url": "https://files.pythonhosted.org/packages/dd/76/ddd7c082ff9780ffaf0944d6a0f76811dac7c7c4214280d5b50eb3141a74/symbolic_regression_toolkit-1.1.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7102d68132de8fee4dfd0dd8567c056f525496e2ceb2c55f5f11bddf155bb675",
                "md5": "f802d9fed8e4bd201ac2a531678b2a02",
                "sha256": "a39453e34d404a4edb914ffec073438f192d2f183e953fca872069a647c348e2"
            },
            "downloads": -1,
            "filename": "symbolic_regression_toolkit-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f802d9fed8e4bd201ac2a531678b2a02",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23991,
            "upload_time": "2024-12-10T15:34:32",
            "upload_time_iso_8601": "2024-12-10T15:34:32.398331Z",
            "url": "https://files.pythonhosted.org/packages/71/02/d68132de8fee4dfd0dd8567c056f525496e2ceb2c55f5f11bddf155bb675/symbolic_regression_toolkit-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-10 15:34:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "smeznar",
    "github_project": "SymbolicRegressionToolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        }
    ],
    "lcname": "symbolic-regression-toolkit"
}
        
Elapsed time: 0.51503s