From 5ac9fbb62cb49b46033d8146e51715ee1fb6b952 Mon Sep 17 00:00:00 2001 From: mcDandy Date: Mon, 15 Jun 2026 19:44:46 +0200 Subject: [PATCH] First part of in comfyUI documentation --- more_math/Parser/MathExpr.g4 | 160 +++++++++++++++++++--------- more_math/Parser/inbuilt_symbols.py | 40 +++---- web/inbuilt_symbols.js | 42 ++++---- 3 files changed, 151 insertions(+), 91 deletions(-) diff --git a/more_math/Parser/MathExpr.g4 b/more_math/Parser/MathExpr.g4 index 658a822..d8c56c1 100644 --- a/more_math/Parser/MathExpr.g4 +++ b/more_math/Parser/MathExpr.g4 @@ -99,24 +99,81 @@ exprList: expr (COMMA expr)*; func0: TIMESTAMP LPAREN RPAREN # TimestampFunc; // Single-argument functions func1: - SIN LPAREN expr RPAREN # SinFunc - | COS LPAREN expr RPAREN # CosFunc - | TAN LPAREN expr RPAREN # TanFunc + /** + sin(x) - applies sinus function to value or each element of value + */ + SIN LPAREN expr RPAREN # SinFunc + /** + cos(x) - applies cosinus function to value or each element of value + */ + | COS LPAREN expr RPAREN # CosFunc + /** + tan(x) - applies tangents function to value or each element of value + */ + | TAN LPAREN expr RPAREN # TanFunc + /** + asin(x) - applies arcus sinus function to value or each element of value + */ | ASIN LPAREN expr RPAREN # AsinFunc + /** + acos(x) - applies arcus cosinus function to value or each element of value + */ | ACOS LPAREN expr RPAREN # AcosFunc + /** + atan(x) - applies arcus tangents function to value or each element of value + */ | ATAN LPAREN expr RPAREN # AtanFunc + /** + sinh(x) - applies hyperbolic sinus function to value or each element of value + */ | SINH LPAREN expr RPAREN # SinhFunc + /** + cosh(x) - applies hyperbolic cosinus function to value or each element of value + */ | COSH LPAREN expr RPAREN # CoshFunc + /** + tanh(x) - applies hyperbolic tangents function to value or each element of value + */ | TANH LPAREN expr RPAREN # TanhFunc + /** + asinh(x) - applies hyperbolic arcus sinus function to value or each element of value + */ | ASINH LPAREN expr RPAREN # AsinhFunc + /** + acosh(x) - applies hyperbolic arcus cosinus function to value or each element of value + */ | ACOSH LPAREN expr RPAREN # AcoshFunc + /** + atanh(x) - applies hyperbolic arcus tangents function to value or each element of value + */ | ATANH LPAREN expr RPAREN # AtanhFunc + /** + abs(x) - applies per element absolute value function. Same as |x| for numbers. + */ | ABS LPAREN expr RPAREN # AbsFunc + /** + sqrt(x) - applies sqere root per element. Negative numbers return NaN (not a number) + */ | SQRT LPAREN expr RPAREN # SqrtFunc + /** + ln(x) - applies natural logarithm to value (per element). Negative numbers return NaN (not a number) + */ | LN LPAREN expr RPAREN # LnFunc + /** + log(x) - applies base 10 logarithm to value (per element). Negative numbers return NaN (not a number) + */ | LOG LPAREN expr RPAREN # LogFunc + /** + exp(x) - applies e^x to value (per element) + */ | EXP LPAREN expr RPAREN # ExpFunc + /** + tnorm(x) - normalises tensor or list by multiplication such that sum(x^2)==1.0 for each slice. The slice is last dimension of the tensor. + */ | TNORM LPAREN expr RPAREN # TNormFunc + /** + snorm(x) - frobenius norm of tensor + */ | SNORM LPAREN expr RPAREN # SNormFunc | FLOOR LPAREN expr RPAREN # FloorFunc | CEIL LPAREN expr RPAREN # CeilFunc @@ -126,24 +183,24 @@ func1: | ANGL LPAREN expr RPAREN # anglFunc | PRNT LPAREN expr RPAREN # printFunc | FRACT LPAREN expr RPAREN # ReluFunc - | SOFTPLUS LPAREN expr RPAREN # SoftplusFunc + | SOFTPLUS LPAREN expr RPAREN # SoftplusFunc | GELU LPAREN expr RPAREN # GeluFunc | SIGN LPAREN expr RPAREN # SignFunc - | PRINT_SHAPE LPAREN expr RPAREN # PrintShapeFunc - | PINV LPAREN expr RPAREN # PinvFunc + | PRINT_SHAPE LPAREN expr RPAREN # PrintShapeFunc + | PINV LPAREN expr RPAREN # PinvFunc | SUM LPAREN expr RPAREN # SumFunc - | MEAN LPAREN expr RPAREN # MeanFunc + | MEAN LPAREN expr RPAREN # MeanFunc | STD LPAREN expr RPAREN # StdFunc | VAR LPAREN expr RPAREN # VarFunc | SORT LPAREN expr RPAREN # SortFunc | ANY LPAREN expr RPAREN # AnyFunc | ALL LPAREN expr RPAREN # AllFunc - | EDGE LPAREN expr (COMMA expr)? RPAREN # EdgeFunc + | EDGE LPAREN expr (COMMA expr)? RPAREN # EdgeFunc | MEDIAN LPAREN expr RPAREN # MedianFunc | MODE LPAREN expr RPAREN # ModeFunc | CUMSUM LPAREN expr RPAREN # CumsumFunc | COUNT LPAREN expr RPAREN # CountFunc - | CUMPROD LPAREN expr RPAREN # CumprodFunc + | CUMPROD LPAREN expr RPAREN # CumprodFunc | POP LPAREN expr RPAREN # PopFunc | CLEAR LPAREN expr RPAREN # ClearFunc | HAS LPAREN expr RPAREN # HasFunc @@ -151,21 +208,21 @@ func1: | ARGSORT LPAREN expr (COMMA expr)? RPAREN # ArgsortFunc | ARGMIN LPAREN expr RPAREN # ArgminFunc | ARGMAX LPAREN expr RPAREN # ArgmaxFunc - | SOFTMAX LPAREN expr (COMMA expr)? RPAREN # SoftmaxFunc - | SOFTMIN LPAREN expr (COMMA expr)? RPAREN # SoftminFunc + | SOFTMAX LPAREN expr (COMMA expr)? RPAREN # SoftmaxFunc + | SOFTMIN LPAREN expr (COMMA expr)? RPAREN # SoftminFunc | ERF LPAREN expr RPAREN # ErfFunc | ERFINV LPAREN expr RPAREN # ErfinvFunc | UNIQUE LPAREN expr RPAREN # UniqueFunc - | FLATTEN LPAREN expr RPAREN # FlattenFunc - | MOTION_MASK LPAREN expr RPAREN # MotionMaskFunc - | FLOW_TO_IMAGE LPAREN expr RPAREN # FlowToImageFunc + | FLATTEN LPAREN expr RPAREN # FlattenFunc + | MOTION_MASK LPAREN expr RPAREN # MotionMaskFunc + | FLOW_TO_IMAGE LPAREN expr RPAREN # FlowToImageFunc | BNOT LPAREN expr RPAREN # BitNotFunc - | BITCOUNT LPAREN expr RPAREN # BitCountFunc + | BITCOUNT LPAREN expr RPAREN # BitCountFunc | SHAPE LPAREN expr RPAREN # ShapeFunc | UPPER LPAREN expr RPAREN # UpperFunc | LOWER LPAREN expr RPAREN # LowerFunc | TRIM LPAREN expr RPAREN # TrimFunc - | ENTROPY LPAREN expr RPAREN # EntropyFunc + | ENTROPY LPAREN expr RPAREN # EntropyFunc | SFFT LPAREN expr RPAREN # SfftFunc | DILATE LPAREN expr (COMMA expr)? RPAREN # DilateFunc | ERODE LPAREN expr (COMMA expr)? RPAREN # ErodeFunc @@ -177,9 +234,12 @@ func1: | FLOW_ANG LPAREN expr RPAREN # FlowAngFunc; func2: - POWE LPAREN expr COMMA expr RPAREN # PowFunc + POWE LPAREN expr COMMA expr RPAREN # PowFunc | ATAN2 LPAREN expr COMMA expr RPAREN # Atan2Func | TMIN LPAREN expr COMMA expr RPAREN # TMinFunc + /** + tmax(x,y) - elementwise maximum of tensor or list. max(x,y) when inputs are floats + */ | TMAX LPAREN expr COMMA expr RPAREN # TMaxFunc | STEP LPAREN expr COMMA expr RPAREN # StepFunc | TOPK LPAREN expr COMMA expr RPAREN # TopkFunc @@ -188,43 +248,43 @@ func2: | PERCENTILE LPAREN expr COMMA expr RPAREN # PercentileFunc | QUANTILE LPAREN expr COMMA expr RPAREN # QuantileFunc | DOT LPAREN expr COMMA expr RPAREN # DotFunc - | COSSIM LPAREN expr COMMA expr RPAREN # CossimFunc + | COSSIM LPAREN expr COMMA expr RPAREN # CossimFunc | FLIP LPAREN expr COMMA expr RPAREN # FlipFunc | COV LPAREN expr COMMA expr RPAREN # CovFunc | CORR LPAREN expr COMMA expr RPAREN # CorrFunc - | APPEND LPAREN expr COMMA expr RPAREN # AppendFunc - | PERM LPAREN expr COMMA expr RPAREN # PermuteFunc + | APPEND LPAREN expr COMMA expr RPAREN # AppendFunc + | PERM LPAREN expr COMMA expr RPAREN # PermuteFunc | GAUSSIAN LPAREN expr COMMA expr (COMMA expr)? RPAREN # GaussianFunc | TOPK_IND LPAREN expr COMMA expr RPAREN # TopkIndFunc | BOTK_IND LPAREN expr COMMA expr RPAREN # BotkIndFunc - | BATCH_SHUFFLE LPAREN expr COMMA expr RPAREN # BatchShuffleFunc - | PUSH LPAREN expr COMMA expr RPAREN # PushFunc - | GET_VALUE LPAREN expr COMMA expr RPAREN # GetValueFunc + | BATCH_SHUFFLE LPAREN expr COMMA expr RPAREN # BatchShuffleFunc + | PUSH LPAREN expr COMMA expr RPAREN # PushFunc + | GET_VALUE LPAREN expr COMMA expr RPAREN # GetValueFunc | TENSOR LPAREN indexExpr (COMMA expr (COMMA expr)? )? RPAREN # EmptyTensorFunc - | PAD LPAREN expr COMMA expr RPAREN # PadFunc - | CROSS LPAREN expr COMMA expr RPAREN # CrossFunc - | MATMUL LPAREN expr COMMA expr RPAREN # MatmulFunc - | FLOW_APPLY LPAREN expr COMMA expr RPAREN # FlowApplyFunc + | PAD LPAREN expr COMMA expr RPAREN # PadFunc + | CROSS LPAREN expr COMMA expr RPAREN # CrossFunc + | MATMUL LPAREN expr COMMA expr RPAREN # MatmulFunc + | FLOW_APPLY LPAREN expr COMMA expr RPAREN # FlowApplyFunc | RIFE LPAREN expr COMMA expr (COMMA expr (COMMA expr (COMMA expr)?)?)? RPAREN # RifeFunc | BAND LPAREN expr COMMA expr RPAREN # BitAndFunc - | XOR LPAREN expr COMMA expr RPAREN # BitXorFunc - | BOR LPAREN expr COMMA expr RPAREN # BitOrFunc - | SPLIT LPAREN expr (COMMA expr)? RPAREN # SplitFunc - | JOIN LPAREN expr (COMMA expr)? RPAREN # JoinFunc + | XOR LPAREN expr COMMA expr RPAREN # BitXorFunc + | BOR LPAREN expr COMMA expr RPAREN # BitOrFunc + | SPLIT LPAREN expr (COMMA expr)? RPAREN # SplitFunc + | JOIN LPAREN expr (COMMA expr)? RPAREN # JoinFunc | SUBSTRING LPAREN expr COMMA expr (COMMA expr)? RPAREN # SubstringFunc - | SUBSTR LPAREN expr COMMA expr (COMMA expr)? RPAREN # SubstringFunc - | FIND LPAREN expr COMMA expr RPAREN # FindFunc - | REPLACE LPAREN expr COMMA expr COMMA expr RPAREN # ReplaceFunc - | INT_TO_RGB LPAREN expr RPAREN # Int_to_rgbFunc - | RGB_TO_INT LPAREN expr ( COMMA expr COMMA expr)? RPAREN # Rgb_to_intFunc - | INTERPOLATE_LINEAR LPAREN expr COMMA expr RPAREN # InterpolateLinearFunc - | INTERPOLATE_AREA LPAREN expr COMMA expr RPAREN # InterpolateAreaFunc - | INTERPOLATE_NEAREST LPAREN expr COMMA expr RPAREN # InterpolateNearestExactFunc + | SUBSTR LPAREN expr COMMA expr (COMMA expr)? RPAREN # SubstringFunc + | FIND LPAREN expr COMMA expr RPAREN # FindFunc + | REPLACE LPAREN expr COMMA expr COMMA expr RPAREN # ReplaceFunc + | INT_TO_RGB LPAREN expr RPAREN # Int_to_rgbFunc + | RGB_TO_INT LPAREN expr ( COMMA expr COMMA expr)? RPAREN # Rgb_to_intFunc + | INTERPOLATE_LINEAR LPAREN expr COMMA expr RPAREN # InterpolateLinearFunc + | INTERPOLATE_AREA LPAREN expr COMMA expr RPAREN # InterpolateAreaFunc + | INTERPOLATE_NEAREST LPAREN expr COMMA expr RPAREN # InterpolateNearestExactFunc ; func3: - CLAMP LPAREN expr COMMA expr COMMA expr RPAREN # ClampFunc - | LERP LPAREN expr COMMA expr COMMA expr RPAREN # LerpFunc + CLAMP LPAREN expr COMMA expr COMMA expr RPAREN # ClampFunc + | LERP LPAREN expr COMMA expr COMMA expr RPAREN # LerpFunc | SMOOTHSTEP LPAREN expr COMMA expr COMMA expr RPAREN # SmoothstepFunc | RANGE LPAREN expr COMMA expr COMMA expr RPAREN # RangeFunc | MOMENT LPAREN expr COMMA expr COMMA expr RPAREN # MomentFunc @@ -232,18 +292,18 @@ func3: | ELASTIC_EASE LPAREN expr COMMA expr COMMA expr RPAREN # ElasticEaseFunc | SINE_EASE LPAREN expr COMMA expr COMMA expr RPAREN # SineEaseFunc | SMOOTHERSTEP LPAREN expr COMMA expr COMMA expr RPAREN # SmootherstepFunc - | CROP LPAREN expr COMMA expr COMMA expr RPAREN # CropFunc + | CROP LPAREN expr COMMA expr COMMA expr RPAREN # CropFunc | SIFFT LPAREN expr (COMMA expr)? RPAREN # SifftFunc | OVERLAY LPAREN expr COMMA expr COMMA expr (COMMA expr)? RPAREN # OverlayFunc | LINSPACE LPAREN expr COMMA expr COMMA expr RPAREN # LinspaceFunc | ROLL LPAREN expr COMMA expr (COMMA expr)? RPAREN # RollFunc - | RGB_TO_OKLAB LPAREN expr (COMMA expr COMMA expr)? RPAREN # RgbToOklabFunc - | RGB_TO_CIELAB LPAREN expr (COMMA expr COMMA expr)? RPAREN # RgbToCielabFunc - | RGB_TO_HSV LPAREN expr (COMMA expr COMMA expr)? (COMMA expr)? RPAREN # RgbToHsvFunc - | HSV_TO_RGB LPAREN expr (COMMA expr COMMA expr)? (COMMA expr)? RPAREN # HsvToRgbFunc - | WHERE LPAREN expr COMMA expr COMMA expr RPAREN # WhereFunc - | OKLAB_TO_RGB LPAREN expr (COMMA expr COMMA expr)? RPAREN # OklabToRgbFunc - | CIELAB_TO_RGB LPAREN expr (COMMA expr COMMA expr)? RPAREN # CielabToRgbFunc + | RGB_TO_OKLAB LPAREN expr (COMMA expr COMMA expr)? RPAREN # RgbToOklabFunc + | RGB_TO_CIELAB LPAREN expr (COMMA expr COMMA expr)? RPAREN # RgbToCielabFunc + | RGB_TO_HSV LPAREN expr (COMMA expr COMMA expr)? (COMMA expr)? RPAREN # RgbToHsvFunc + | HSV_TO_RGB LPAREN expr (COMMA expr COMMA expr)? (COMMA expr)? RPAREN # HsvToRgbFunc + | WHERE LPAREN expr COMMA expr COMMA expr RPAREN # WhereFunc + | OKLAB_TO_RGB LPAREN expr (COMMA expr COMMA expr)? RPAREN # OklabToRgbFunc + | CIELAB_TO_RGB LPAREN expr (COMMA expr COMMA expr)? RPAREN # CielabToRgbFunc | TEXT_IMAGE LPAREN expr COMMA expr COMMA expr (COMMA expr)? (COMMA expr)? (COMMA expr)? (COMMA expr)? (COMMA expr)? (COMMA expr)? RPAREN # TextImageFunc; func4: @@ -270,7 +330,7 @@ funcNoise: NOISE LPAREN expr (COMMA expr)? RPAREN # NoiseFunc | RAND LPAREN expr (COMMA expr)? RPAREN # RandFunc | EXPONENTIAL LPAREN expr COMMA expr (COMMA expr)? RPAREN # ExponentialFunc - | BERNOULLI LPAREN expr COMMA expr (COMMA expr)? RPAREN # BernoulliFunc + | BERNOULLI LPAREN expr COMMA expr (COMMA expr)? RPAREN # BernoulliFunc | POISSON LPAREN expr COMMA expr (COMMA expr)? RPAREN # PoissonFunc | CAUCHY LPAREN expr COMMA expr COMMA expr (COMMA expr)? RPAREN # CauchyFunc | LOGNORMAL LPAREN expr COMMA expr COMMA expr (COMMA expr)? RPAREN # LogNormalFunc diff --git a/more_math/Parser/inbuilt_symbols.py b/more_math/Parser/inbuilt_symbols.py index 804da91..b1e42d6 100644 --- a/more_math/Parser/inbuilt_symbols.py +++ b/more_math/Parser/inbuilt_symbols.py @@ -10,9 +10,9 @@ INBUILT_FUNCTIONS = { } INBUILT_FUNCTION_META = { - 'abs': {'min_args': 1, 'max_args': 1, 'snippet': 'abs()', 'description': ''}, - 'acos': {'min_args': 1, 'max_args': 1, 'snippet': 'acos()', 'description': ''}, - 'acosh': {'min_args': 1, 'max_args': 1, 'snippet': 'acosh()', 'description': ''}, + 'abs': {'min_args': 1, 'max_args': 1, 'snippet': 'abs()', 'description': 'abs(x) - applies per element absolute value function. Same as |x| for numbers.'}, + 'acos': {'min_args': 1, 'max_args': 1, 'snippet': 'acos()', 'description': 'acos(x) - applies arcus cosinus function to value or each element of value'}, + 'acosh': {'min_args': 1, 'max_args': 1, 'snippet': 'acosh()', 'description': 'acosh(x) - applies hyperbolic arcus cosinus function to value or each element of value'}, 'all': {'min_args': 1, 'max_args': 1, 'snippet': 'all()', 'description': ''}, 'angle': {'min_args': 1, 'max_args': 1, 'snippet': 'angle()', 'description': ''}, 'any': {'min_args': 1, 'max_args': 1, 'snippet': 'any()', 'description': ''}, @@ -20,11 +20,11 @@ INBUILT_FUNCTION_META = { 'argmax': {'min_args': 1, 'max_args': 1, 'snippet': 'argmax()', 'description': ''}, 'argmin': {'min_args': 1, 'max_args': 1, 'snippet': 'argmin()', 'description': ''}, 'argsort': {'min_args': 1, 'max_args': 2, 'snippet': 'argsort()', 'description': ''}, - 'asin': {'min_args': 1, 'max_args': 1, 'snippet': 'asin()', 'description': ''}, - 'asinh': {'min_args': 1, 'max_args': 1, 'snippet': 'asinh()', 'description': ''}, - 'atan': {'min_args': 1, 'max_args': 1, 'snippet': 'atan()', 'description': ''}, + 'asin': {'min_args': 1, 'max_args': 1, 'snippet': 'asin()', 'description': 'asin(x) - applies arcus sinus function to value or each element of value'}, + 'asinh': {'min_args': 1, 'max_args': 1, 'snippet': 'asinh()', 'description': 'asinh(x) - applies hyperbolic arcus sinus function to value or each element of value'}, + 'atan': {'min_args': 1, 'max_args': 1, 'snippet': 'atan()', 'description': 'atan(x) - applies arcus tangents function to value or each element of value'}, 'atan2': {'min_args': 2, 'max_args': 2, 'snippet': 'atan2()', 'description': ''}, - 'atanh': {'min_args': 1, 'max_args': 1, 'snippet': 'atanh()', 'description': ''}, + 'atanh': {'min_args': 1, 'max_args': 1, 'snippet': 'atanh()', 'description': 'atanh(x) - applies hyperbolic arcus tangents function to value or each element of value'}, 'band': {'min_args': 2, 'max_args': 2, 'snippet': 'band()', 'description': ''}, 'batch_shuffle': {'min_args': 2, 'max_args': 2, 'snippet': 'batch_shuffle()', 'description': ''}, 'bitcount': {'min_args': 1, 'max_args': 1, 'snippet': 'bitcount()', 'description': ''}, @@ -52,8 +52,8 @@ INBUILT_FUNCTION_META = { 'convolution': {'min_args': 2, 'max_args': None, 'snippet': 'convolution()', 'description': ''}, 'corr': {'min_args': 2, 'max_args': 2, 'snippet': 'corr()', 'description': ''}, 'correlation': {'min_args': 2, 'max_args': 2, 'snippet': 'correlation()', 'description': ''}, - 'cos': {'min_args': 1, 'max_args': 1, 'snippet': 'cos()', 'description': ''}, - 'cosh': {'min_args': 1, 'max_args': 1, 'snippet': 'cosh()', 'description': ''}, + 'cos': {'min_args': 1, 'max_args': 1, 'snippet': 'cos()', 'description': 'cos(x) - applies cosinus function to value or each element of value'}, + 'cosh': {'min_args': 1, 'max_args': 1, 'snippet': 'cosh()', 'description': 'cosh(x) - applies hyperbolic cosinus function to value or each element of value'}, 'cosine_similarity': {'min_args': 2, 'max_args': 2, 'snippet': 'cosine_similarity()', 'description': ''}, 'cossim': {'min_args': 2, 'max_args': 2, 'snippet': 'cossim()', 'description': ''}, 'count': {'min_args': 1, 'max_args': 1, 'snippet': 'count()', 'description': ''}, @@ -77,7 +77,7 @@ INBUILT_FUNCTION_META = { 'erf': {'min_args': 1, 'max_args': 1, 'snippet': 'erf()', 'description': ''}, 'erfinv': {'min_args': 1, 'max_args': 1, 'snippet': 'erfinv()', 'description': ''}, 'erode': {'min_args': 1, 'max_args': 2, 'snippet': 'erode()', 'description': ''}, - 'exp': {'min_args': 1, 'max_args': 1, 'snippet': 'exp()', 'description': ''}, + 'exp': {'min_args': 1, 'max_args': 1, 'snippet': 'exp()', 'description': 'exp(x) - applies e^x to value (per element)'}, 'ezconv': {'min_args': 2, 'max_args': None, 'snippet': 'ezconv()', 'description': ''}, 'ezconvolution': {'min_args': 2, 'max_args': None, 'snippet': 'ezconvolution()', 'description': ''}, 'fft': {'min_args': 1, 'max_args': 1, 'snippet': 'fft()', 'description': ''}, @@ -111,8 +111,8 @@ INBUILT_FUNCTION_META = { 'length': {'min_args': 1, 'max_args': 1, 'snippet': 'length()', 'description': ''}, 'lerp': {'min_args': 3, 'max_args': 3, 'snippet': 'lerp()', 'description': ''}, 'linspace': {'min_args': 3, 'max_args': 3, 'snippet': 'linspace()', 'description': ''}, - 'ln': {'min_args': 1, 'max_args': 1, 'snippet': 'ln()', 'description': ''}, - 'log': {'min_args': 1, 'max_args': 1, 'snippet': 'log()', 'description': ''}, + 'ln': {'min_args': 1, 'max_args': 1, 'snippet': 'ln()', 'description': 'ln(x) - applies natural logarithm to value (per element). Negative numbers return NaN (not a number)'}, + 'log': {'min_args': 1, 'max_args': 1, 'snippet': 'log()', 'description': 'log(x) - applies base 10 logarithm to value (per element). Negative numbers return NaN (not a number)'}, 'logspace': {'min_args': 4, 'max_args': 4, 'snippet': 'logspace()', 'description': ''}, 'lower': {'min_args': 1, 'max_args': 1, 'snippet': 'lower()', 'description': ''}, 'map': {'min_args': 2, 'max_args': None, 'snippet': 'map()', 'description': ''}, @@ -198,21 +198,21 @@ INBUILT_FUNCTION_META = { 'shuffle': {'min_args': 2, 'max_args': 2, 'snippet': 'shuffle()', 'description': ''}, 'sigm': {'min_args': 1, 'max_args': 1, 'snippet': 'sigm()', 'description': ''}, 'sign': {'min_args': 1, 'max_args': 1, 'snippet': 'sign()', 'description': ''}, - 'sin': {'min_args': 1, 'max_args': 1, 'snippet': 'sin()', 'description': ''}, + 'sin': {'min_args': 1, 'max_args': 1, 'snippet': 'sin()', 'description': 'sin(x) - applies sinus function to value or each element of value'}, 'sine': {'min_args': 3, 'max_args': 3, 'snippet': 'sine()', 'description': ''}, 'sine_ease': {'min_args': 3, 'max_args': 3, 'snippet': 'sine_ease()', 'description': ''}, - 'sinh': {'min_args': 1, 'max_args': 1, 'snippet': 'sinh()', 'description': ''}, + 'sinh': {'min_args': 1, 'max_args': 1, 'snippet': 'sinh()', 'description': 'sinh(x) - applies hyperbolic sinus function to value or each element of value'}, 'smax': {'min_args': 1, 'max_args': None, 'snippet': 'smax()', 'description': ''}, 'smin': {'min_args': 1, 'max_args': None, 'snippet': 'smin()', 'description': ''}, 'smootherstep': {'min_args': 3, 'max_args': 3, 'snippet': 'smootherstep()', 'description': ''}, 'smoothstep': {'min_args': 3, 'max_args': 3, 'snippet': 'smoothstep()', 'description': ''}, - 'snorm': {'min_args': 1, 'max_args': 1, 'snippet': 'snorm()', 'description': ''}, + 'snorm': {'min_args': 1, 'max_args': 1, 'snippet': 'snorm()', 'description': 'snorm(x) - frobenius norm of tensor'}, 'softmax': {'min_args': 1, 'max_args': 2, 'snippet': 'softmax()', 'description': ''}, 'softmin': {'min_args': 1, 'max_args': 2, 'snippet': 'softmin()', 'description': ''}, 'softplus': {'min_args': 1, 'max_args': 1, 'snippet': 'softplus()', 'description': ''}, 'sort': {'min_args': 1, 'max_args': 1, 'snippet': 'sort()', 'description': ''}, 'split': {'min_args': 1, 'max_args': 2, 'snippet': 'split()', 'description': ''}, - 'sqrt': {'min_args': 1, 'max_args': 1, 'snippet': 'sqrt()', 'description': ''}, + 'sqrt': {'min_args': 1, 'max_args': 1, 'snippet': 'sqrt()', 'description': 'sqrt(x) - applies sqere root per element. Negative numbers return NaN (not a number)'}, 'stack_clear': {'min_args': 1, 'max_args': 1, 'snippet': 'stack_clear()', 'description': ''}, 'stack_get': {'min_args': 1, 'max_args': 1, 'snippet': 'stack_get()', 'description': ''}, 'stack_has': {'min_args': 1, 'max_args': 1, 'snippet': 'stack_has()', 'description': ''}, @@ -224,14 +224,14 @@ INBUILT_FUNCTION_META = { 'substring': {'min_args': 2, 'max_args': 3, 'snippet': 'substring()', 'description': ''}, 'sum': {'min_args': 1, 'max_args': 1, 'snippet': 'sum()', 'description': ''}, 'swap': {'min_args': 4, 'max_args': 4, 'snippet': 'swap()', 'description': ''}, - 'tan': {'min_args': 1, 'max_args': 1, 'snippet': 'tan()', 'description': ''}, - 'tanh': {'min_args': 1, 'max_args': 1, 'snippet': 'tanh()', 'description': ''}, + 'tan': {'min_args': 1, 'max_args': 1, 'snippet': 'tan()', 'description': 'tan(x) - applies tangents function to value or each element of value'}, + 'tanh': {'min_args': 1, 'max_args': 1, 'snippet': 'tanh()', 'description': 'tanh(x) - applies hyperbolic tangents function to value or each element of value'}, 'tensor': {'min_args': 2, 'max_args': 3, 'snippet': 'tensor()', 'description': ''}, 'text_image': {'min_args': 3, 'max_args': 9, 'snippet': 'text_image()', 'description': ''}, 'timestamp': {'min_args': 0, 'max_args': 0, 'snippet': 'timestamp()', 'description': ''}, - 'tmax': {'min_args': 2, 'max_args': 2, 'snippet': 'tmax()', 'description': ''}, + 'tmax': {'min_args': 2, 'max_args': 2, 'snippet': 'tmax()', 'description': 'tmax(x,y) - elementwise maximum of tensor or list. max(x,y) when inputs are floats'}, 'tmin': {'min_args': 2, 'max_args': 2, 'snippet': 'tmin()', 'description': ''}, - 'tnorm': {'min_args': 1, 'max_args': 1, 'snippet': 'tnorm()', 'description': ''}, + 'tnorm': {'min_args': 1, 'max_args': 1, 'snippet': 'tnorm()', 'description': 'tnorm(x) - normalises tensor or list by multiplication such that sum(x^2)==1.0 for each slice. The slice is last dimension of the tensor.'}, 'topk': {'min_args': 2, 'max_args': 2, 'snippet': 'topk()', 'description': ''}, 'topk_ind': {'min_args': 2, 'max_args': 2, 'snippet': 'topk_ind()', 'description': ''}, 'topk_indices': {'min_args': 2, 'max_args': 2, 'snippet': 'topk_indices()', 'description': ''}, diff --git a/web/inbuilt_symbols.js b/web/inbuilt_symbols.js index 8104c4e..2a8c645 100644 --- a/web/inbuilt_symbols.js +++ b/web/inbuilt_symbols.js @@ -13,9 +13,9 @@ export const FUNCTIONS = new Set([ ]); export const FUNCTION_META = { - abs: { minArgs: 1, maxArgs: 1, snippet: "abs()", description: "" }, - acos: { minArgs: 1, maxArgs: 1, snippet: "acos()", description: "" }, - acosh: { minArgs: 1, maxArgs: 1, snippet: "acosh()", description: "" }, + abs: { minArgs: 1, maxArgs: 1, snippet: "abs()", description: "abs(x) - applies per element absolute value function. Same as |x| for numbers." }, + acos: { minArgs: 1, maxArgs: 1, snippet: "acos()", description: "acos(x) - applies arcus cosinus function to value or each element of value" }, + acosh: { minArgs: 1, maxArgs: 1, snippet: "acosh()", description: "acosh(x) - applies hyperbolic arcus cosinus function to value or each element of value" }, all: { minArgs: 1, maxArgs: 1, snippet: "all()", description: "" }, angle: { minArgs: 1, maxArgs: 1, snippet: "angle()", description: "" }, any: { minArgs: 1, maxArgs: 1, snippet: "any()", description: "" }, @@ -23,11 +23,11 @@ export const FUNCTION_META = { argmax: { minArgs: 1, maxArgs: 1, snippet: "argmax()", description: "" }, argmin: { minArgs: 1, maxArgs: 1, snippet: "argmin()", description: "" }, argsort: { minArgs: 1, maxArgs: 2, snippet: "argsort()", description: "" }, - asin: { minArgs: 1, maxArgs: 1, snippet: "asin()", description: "" }, - asinh: { minArgs: 1, maxArgs: 1, snippet: "asinh()", description: "" }, - atan: { minArgs: 1, maxArgs: 1, snippet: "atan()", description: "" }, + asin: { minArgs: 1, maxArgs: 1, snippet: "asin()", description: "asin(x) - applies arcus sinus function to value or each element of value" }, + asinh: { minArgs: 1, maxArgs: 1, snippet: "asinh()", description: "asinh(x) - applies hyperbolic arcus sinus function to value or each element of value" }, + atan: { minArgs: 1, maxArgs: 1, snippet: "atan()", description: "atan(x) - applies arcus tangents function to value or each element of value" }, atan2: { minArgs: 2, maxArgs: 2, snippet: "atan2()", description: "" }, - atanh: { minArgs: 1, maxArgs: 1, snippet: "atanh()", description: "" }, + atanh: { minArgs: 1, maxArgs: 1, snippet: "atanh()", description: "atanh(x) - applies hyperbolic arcus tangents function to value or each element of value" }, band: { minArgs: 2, maxArgs: 2, snippet: "band()", description: "" }, batch_shuffle: { minArgs: 2, maxArgs: 2, snippet: "batch_shuffle()", description: "" }, bitcount: { minArgs: 1, maxArgs: 1, snippet: "bitcount()", description: "" }, @@ -55,8 +55,8 @@ export const FUNCTION_META = { convolution: { minArgs: 2, maxArgs: null, snippet: "convolution()", description: "" }, corr: { minArgs: 2, maxArgs: 2, snippet: "corr()", description: "" }, correlation: { minArgs: 2, maxArgs: 2, snippet: "correlation()", description: "" }, - cos: { minArgs: 1, maxArgs: 1, snippet: "cos()", description: "" }, - cosh: { minArgs: 1, maxArgs: 1, snippet: "cosh()", description: "" }, + cos: { minArgs: 1, maxArgs: 1, snippet: "cos()", description: "cos(x) - applies cosinus function to value or each element of value" }, + cosh: { minArgs: 1, maxArgs: 1, snippet: "cosh()", description: "cosh(x) - applies hyperbolic cosinus function to value or each element of value" }, cosine_similarity: { minArgs: 2, maxArgs: 2, snippet: "cosine_similarity()", description: "" }, cossim: { minArgs: 2, maxArgs: 2, snippet: "cossim()", description: "" }, count: { minArgs: 1, maxArgs: 1, snippet: "count()", description: "" }, @@ -80,7 +80,7 @@ export const FUNCTION_META = { erf: { minArgs: 1, maxArgs: 1, snippet: "erf()", description: "" }, erfinv: { minArgs: 1, maxArgs: 1, snippet: "erfinv()", description: "" }, erode: { minArgs: 1, maxArgs: 2, snippet: "erode()", description: "" }, - exp: { minArgs: 1, maxArgs: 1, snippet: "exp()", description: "" }, + exp: { minArgs: 1, maxArgs: 1, snippet: "exp()", description: "exp(x) - applies e^x to value (per element)" }, ezconv: { minArgs: 2, maxArgs: null, snippet: "ezconv()", description: "" }, ezconvolution: { minArgs: 2, maxArgs: null, snippet: "ezconvolution()", description: "" }, fft: { minArgs: 1, maxArgs: 1, snippet: "fft()", description: "" }, @@ -114,8 +114,8 @@ export const FUNCTION_META = { length: { minArgs: 1, maxArgs: 1, snippet: "length()", description: "" }, lerp: { minArgs: 3, maxArgs: 3, snippet: "lerp()", description: "" }, linspace: { minArgs: 3, maxArgs: 3, snippet: "linspace()", description: "" }, - ln: { minArgs: 1, maxArgs: 1, snippet: "ln()", description: "" }, - log: { minArgs: 1, maxArgs: 1, snippet: "log()", description: "" }, + ln: { minArgs: 1, maxArgs: 1, snippet: "ln()", description: "ln(x) - applies natural logarithm to value (per element). Negative numbers return NaN (not a number)" }, + log: { minArgs: 1, maxArgs: 1, snippet: "log()", description: "log(x) - applies base 10 logarithm to value (per element). Negative numbers return NaN (not a number)" }, logspace: { minArgs: 4, maxArgs: 4, snippet: "logspace()", description: "" }, lower: { minArgs: 1, maxArgs: 1, snippet: "lower()", description: "" }, map: { minArgs: 2, maxArgs: null, snippet: "map()", description: "" }, @@ -177,7 +177,7 @@ export const FUNCTION_META = { random_studentt: { minArgs: 2, maxArgs: 3, snippet: "random_studentt()", description: "" }, random_uniform: { minArgs: 1, maxArgs: 2, snippet: "random_uniform()", description: "" }, random_weibull: { minArgs: 3, maxArgs: 4, snippet: "random_weibull()", description: "" }, - randp: { minArgs: 2, maxArgs: 3, snippet: "randp()", description: "aaa" }, + randp: { minArgs: 2, maxArgs: 3, snippet: "randp()", description: "" }, randt: { minArgs: 2, maxArgs: 3, snippet: "randt()", description: "" }, randu: { minArgs: 1, maxArgs: 2, snippet: "randu()", description: "" }, randw: { minArgs: 3, maxArgs: 4, snippet: "randw()", description: "" }, @@ -201,21 +201,21 @@ export const FUNCTION_META = { shuffle: { minArgs: 2, maxArgs: 2, snippet: "shuffle()", description: "" }, sigm: { minArgs: 1, maxArgs: 1, snippet: "sigm()", description: "" }, sign: { minArgs: 1, maxArgs: 1, snippet: "sign()", description: "" }, - sin: { minArgs: 1, maxArgs: 1, snippet: "sin()", description: "" }, + sin: { minArgs: 1, maxArgs: 1, snippet: "sin()", description: "sin(x) - applies sinus function to value or each element of value" }, sine: { minArgs: 3, maxArgs: 3, snippet: "sine()", description: "" }, sine_ease: { minArgs: 3, maxArgs: 3, snippet: "sine_ease()", description: "" }, - sinh: { minArgs: 1, maxArgs: 1, snippet: "sinh()", description: "" }, + sinh: { minArgs: 1, maxArgs: 1, snippet: "sinh()", description: "sinh(x) - applies hyperbolic sinus function to value or each element of value" }, smax: { minArgs: 1, maxArgs: null, snippet: "smax()", description: "" }, smin: { minArgs: 1, maxArgs: null, snippet: "smin()", description: "" }, smootherstep: { minArgs: 3, maxArgs: 3, snippet: "smootherstep()", description: "" }, smoothstep: { minArgs: 3, maxArgs: 3, snippet: "smoothstep()", description: "" }, - snorm: { minArgs: 1, maxArgs: 1, snippet: "snorm()", description: "" }, + snorm: { minArgs: 1, maxArgs: 1, snippet: "snorm()", description: "snorm(x) - frobenius norm of tensor" }, softmax: { minArgs: 1, maxArgs: 2, snippet: "softmax()", description: "" }, softmin: { minArgs: 1, maxArgs: 2, snippet: "softmin()", description: "" }, softplus: { minArgs: 1, maxArgs: 1, snippet: "softplus()", description: "" }, sort: { minArgs: 1, maxArgs: 1, snippet: "sort()", description: "" }, split: { minArgs: 1, maxArgs: 2, snippet: "split()", description: "" }, - sqrt: { minArgs: 1, maxArgs: 1, snippet: "sqrt()", description: "" }, + sqrt: { minArgs: 1, maxArgs: 1, snippet: "sqrt()", description: "sqrt(x) - applies sqere root per element. Negative numbers return NaN (not a number)" }, stack_clear: { minArgs: 1, maxArgs: 1, snippet: "stack_clear()", description: "" }, stack_get: { minArgs: 1, maxArgs: 1, snippet: "stack_get()", description: "" }, stack_has: { minArgs: 1, maxArgs: 1, snippet: "stack_has()", description: "" }, @@ -227,14 +227,14 @@ export const FUNCTION_META = { substring: { minArgs: 2, maxArgs: 3, snippet: "substring()", description: "" }, sum: { minArgs: 1, maxArgs: 1, snippet: "sum()", description: "" }, swap: { minArgs: 4, maxArgs: 4, snippet: "swap()", description: "" }, - tan: { minArgs: 1, maxArgs: 1, snippet: "tan()", description: "" }, - tanh: { minArgs: 1, maxArgs: 1, snippet: "tanh()", description: "" }, + tan: { minArgs: 1, maxArgs: 1, snippet: "tan()", description: "tan(x) - applies tangents function to value or each element of value" }, + tanh: { minArgs: 1, maxArgs: 1, snippet: "tanh()", description: "tanh(x) - applies hyperbolic tangents function to value or each element of value" }, tensor: { minArgs: 2, maxArgs: 3, snippet: "tensor()", description: "" }, text_image: { minArgs: 3, maxArgs: 9, snippet: "text_image()", description: "" }, timestamp: { minArgs: 0, maxArgs: 0, snippet: "timestamp()", description: "" }, - tmax: { minArgs: 2, maxArgs: 2, snippet: "tmax()", description: "" }, + tmax: { minArgs: 2, maxArgs: 2, snippet: "tmax()", description: "tmax(x,y) - elementwise maximum of tensor or list. max(x,y) when inputs are floats" }, tmin: { minArgs: 2, maxArgs: 2, snippet: "tmin()", description: "" }, - tnorm: { minArgs: 1, maxArgs: 1, snippet: "tnorm()", description: "" }, + tnorm: { minArgs: 1, maxArgs: 1, snippet: "tnorm()", description: "tnorm(x) - normalises tensor or list by multiplication such that sum(x^2)==1.0 for each slice. The slice is last dimension of the tensor." }, topk: { minArgs: 2, maxArgs: 2, snippet: "topk()", description: "" }, topk_ind: { minArgs: 2, maxArgs: 2, snippet: "topk_ind()", description: "" }, topk_indices: { minArgs: 2, maxArgs: 2, snippet: "topk_indices()", description: "" },