pandoc-symreg: A tool to convert symbolic regression expressions into different formats.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

These packages miss upper bounds: - srtree-eqsat Please add them, using `cabal gen-bounds` for suggestions. For more information see: https://pvp.haskell.org/

A pandoc-like cli tool and library to convert symbolic regression expressions to convenient formats

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.1.0.1, 0.2.0.0, 0.2.1.0, 0.2.1.0, 0.2.1.1, 0.2.1.3
Change log	CHANGELOG.md
Dependencies	attoparsec (>=0.14 && <0.15), attoparsec-expr (>=0.1 && <0.2), base (>=4.16 && <4.18), bytestring (>=0.11 && <0.12), mtl (>=2.2 && <2.3), optparse-applicative (>=0.17 && <0.18), pandoc-symreg, srtree (>=1.0.0.2 && <1.1), srtree-eqsat [details]
License	GPL-3.0-only
Copyright	2023 Fabricio Olivetti de França
Author	Fabricio Olivetti de França
Maintainer	fabricio.olivetti@gmail.com
Category	Text, Math
Home page	https://github.com/folivetti/pandoc-symreg#readme
Bug tracker	https://github.com/folivetti/pandoc-symreg/issues
Source repo	head: git clone https://github.com/folivetti/pandoc-symreg
Uploaded	by olivetti at 2023-05-20T11:07:11Z

Modules

Text
- Text.ParseSR
  - Text.ParseSR.IO

Downloads

pandoc-symreg-0.2.1.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

olivetti

For package maintainers and hackage trustees

edit package information

Readme for pandoc-symreg-0.2.1.0

[back to package description]

pandoc-symreg: a pandoc-like tool to convert symbolic regression expressions to convenient formats.

Conversion tool for Symbolic Regression tools

Pandoc-Symreg is a Haskell library and CLI inspired by Pandoc for converting the output of Symbolic Regression tools to convenient formats for post analysis and documentation. It currently supports converting the output from

TIR (Transformation-Interaction-Rational Symbolic Regression)
HL (HeuristicLab)
Operon (Operon)
Bingo (Bingo)
GP-GOMEA (GP-GOMEA)
PySR (PySR)
SBP (SBP)
EPLEX

And it can convert to

python (Numpy expression)
math (Plain math expression)
tikz (TikZ code to print a tree)
latex (LaTeX equation)

Installing

This tool can be installed via Cabal or Stack. The easiest way to install is via Haskell stack:

Install Haskell Tool Stack
Clone this repository
Inside the project directory run the command stack install

There are also binaries available at releases

Usage

Usage: pandoc-symreg (-f|--from ['tir'|'hl'|'operon'|'bingo'])
                     (-t|--to ['python'|'math'|'tikz'|'latex']) 
                     [-i|--input INPUT] [-o|--output OUTPUT] 
                     [-v|--varnames VARNAMES] [-p|--parameters]

  Convert different symbolic expressions format to common formats.

Available options:
  -f,--from ['tir'|'hl'|'operon'|'bingo']
                           Input expression format
  -t,--to ['python'|'math'|'tikz'|'latex']
                           Output expression format
  -i,--input INPUT         Input file containing expressions. Empty string gets
                           expression from stdin. (default: "")
  -o,--output OUTPUT       Output file to store expressions. Empty string prints
                           expressions to stdout. (default: "")
  -v,--varnames VARNAMES   Comma separated list of variables names. Empty list
                           assumes the default of each algorithm (e.g,
                           "x,y,epsilon"). (default: "")
  -p,--parameters          Convert floating point numbers to free parameters.
  -h,--help                Show this help text

Contributing

If you want to add support to your SR algorithm, have a look at the file src/PandocSR.hs at the current parsers. You can either modify that file and make a Pull request or open an issue with the following informations:

The name of your algorithm
A list of supported univariate functions and their string representations
A list of supported bivariate functions and their string representations
A list of supported binary operators and their string representations. The string representation is sensitive to whether the operator is surrounded by space or not. See the source code for some examples.

Notice that we currently support a limited set of math functions and operators. See SRTree for the current list. Please open an issue describing any other function that you want to be supported.

If you want to add support to other output formats. Please open an issue with a description of the format and a link to the official project of the format, if any.

Bug reports and feature requests are welcome.

License

© 2023-2023 Fabricio Olivetti de Franca (fabricio.olivetti@gmail.com). Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)