From 847f963e779699b0788eac3ce1b88cab5e13cc19 Mon Sep 17 00:00:00 2001 From: WassimTenachi Date: Mon, 2 Oct 2023 13:55:40 +0200 Subject: [PATCH] non physical SR doc --- README.md | 6 ++++++ docs/source/doc_getting_started_sr.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 714efcd..1e05232 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,12 @@ It should be noted that here the units vector are of size 3 (eg: `[1, 0, 0]`) as However, units vectors can be of any size $\leq 7$ as long as it is consistent across X, y and constants, allowing the user to express any units (dependent on length, time, mass, temperature, electric current, amount of light, or amount of matter). In addition, dimensional analysis can be performed regardless of the order in which units are given, allowing the user to use any convention ([length, mass, time] or [mass, time, length] etc.) as long as it is consistent across X,y and constants. +--- + +**NOTE** : If you are not working on a physics problem and all your variables/constants are dimensionless, do not specify the units arguments (or specify them as `[0,0]` for all variables/constants) and `physo` will perform a dimensionless symbolic regression task. + +--- + It should also be noted that free constants search starts around 1. by default. Therefore when using default hyperparameters, normalizing the data around an order of magnitude of 1 is strongly recommended. diff --git a/docs/source/doc_getting_started_sr.md b/docs/source/doc_getting_started_sr.md index 56a9bcf..823827c 100644 --- a/docs/source/doc_getting_started_sr.md +++ b/docs/source/doc_getting_started_sr.md @@ -30,6 +30,12 @@ It should be noted that here the units vector are of size 3 (eg: `[1, 0, 0]`) as However, units vectors can be of any size $\leq 7$ as long as it is consistent across X, y and constants, allowing the user to express any units (dependent on length, time, mass, temperature, electric current, amount of light, or amount of matter). In addition, dimensional analysis can be performed regardless of the order in which units are given, allowing the user to use any convention ([length, mass, time] or [mass, time, length] etc.) as long as it is consistent across X,y and constants. +--- + +**NOTE** : If you are not working on a physics problem and all your variables/constants are dimensionless, do not specify the units arguments (or specify them as `[0,0]` for all variables/constants) and `physo` will perform a dimensionless symbolic regression task. + +--- + It should also be noted that free constants search starts around 1. by default. Therefore when using default hyperparameters, normalizing the data around an order of magnitude of 1 is strongly recommended.