From c270d4f82fa2a1ca729510e7838a979ac13543bc Mon Sep 17 00:00:00 2001 From: itsjoeoui Date: Sat, 7 Oct 2023 03:57:40 +0000 Subject: [PATCH 1/2] update: update --- .../ACCURACY/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 26 ++ .../a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 27 ++ .../ONNX_MODEL/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 16 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 27 ++ .../LEAST_SQUARES/a1-[autogen]/docstring.json | 16 + .../DEEPLAB_V3/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../OPEN_IMAGE/a1-[autogen]/docstring.json | 17 + .../OPEN_PARQUET/a1-[autogen]/docstring.json | 17 + .../FILE/READ_CSV/a1-[autogen]/docstring.json | 17 + .../FILE/READ_S3/a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../TEXT_DATASET/a1-[autogen]/docstring.json | 37 +++ .../SKIMAGE/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 47 +++ .../CONSTANT/a1-[autogen]/docstring.json | 27 ++ .../FEEDBACK/a1-[autogen]/docstring.json | 11 + .../LINSPACE/a1-[autogen]/docstring.json | 27 ++ .../MATRIX/a1-[autogen]/docstring.json | 22 ++ .../POPULATE/a1-[autogen]/docstring.json | 42 +++ .../RAND/a1-[autogen]/docstring.json | 47 +++ .../SCALAR/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 22 ++ .../SINE/a1-[autogen]/docstring.json | 37 +++ .../TEXT/a1-[autogen]/docstring.json | 17 + .../TIMESERIES/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 17 + .../WAVEPACKET/a1-[autogen]/docstring.json | 37 +++ .../a1-[autogen]/docstring.json | 16 + .../LM34/a1-[autogen]/docstring.json | 11 + .../OPEN_WEBCAM/a1-[autogen]/docstring.json | 22 ++ .../WEBCAM/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 27 ++ .../READ_A0_PINS/a1-[autogen]/docstring.json | 11 + .../READ_N_PINS/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 62 ++++ .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../ON_OFF_33510B/a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 72 ++++ .../WEINSCHEL8320/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../DIODE_USB4065/a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 32 ++ .../a1-[autogen]/docstring.json | 37 +++ .../a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 32 ++ .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 27 ++ .../CLOSE_ALL/a1-[autogen]/docstring.json | 11 + .../LIST_VISA/a1-[autogen]/docstring.json | 11 + .../VISA_IDENTITY/a1-[autogen]/docstring.json | 22 ++ .../IV_SWEEP/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../POLULU/TIC/a1-[autogen]/docstring.json | 21 ++ .../TIC_KNOB/a1-[autogen]/docstring.json | 26 ++ .../SCPI/IDN/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../OPEN_SERIAL/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 16 + .../a1-[autogen]/docstring.json | 31 ++ .../ACTIVATE/a1-[autogen]/docstring.json | 11 + .../CONNECT/a1-[autogen]/docstring.json | 11 + .../DELAY/a1-[autogen]/docstring.json | 11 + .../DISCONNECT/a1-[autogen]/docstring.json | 5 + .../HOME/a1-[autogen]/docstring.json | 11 + .../MOVE_JOINT/a1-[autogen]/docstring.json | 11 + .../MOVE_LIN/a1-[autogen]/docstring.json | 11 + .../MOVE_POSE/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../SET_JOINT_VEL/a1-[autogen]/docstring.json | 5 + .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 17 + .../DS_LOAD/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 42 +++ .../LOCAL_FILE/a1-[autogen]/docstring.json | 27 ++ .../OPEN_MATLAB/a1-[autogen]/docstring.json | 17 + .../REMOTE_FILE/a1-[autogen]/docstring.json | 27 ++ .../CONDITIONAL/a1-[autogen]/docstring.json | 11 + .../LOOPS/APPEND/a1-[autogen]/docstring.json | 11 + .../LOOPS/LOOP/a1-[autogen]/docstring.json | 11 + .../BREAK/a1-[autogen]/docstring.json | 16 + .../LOOP_INDEX/a1-[autogen]/docstring.json | 17 + .../TIMERS/TIMER/a1-[autogen]/docstring.json | 11 + .../CHOLESKY/a1-[autogen]/docstring.json | 17 + .../LINALG/DET/a1-[autogen]/docstring.json | 17 + .../LINALG/EIG/a1-[autogen]/docstring.json | 22 ++ .../LINALG/EIGH/a1-[autogen]/docstring.json | 11 + .../EIGVALS/a1-[autogen]/docstring.json | 17 + .../EIGVALSH/a1-[autogen]/docstring.json | 22 ++ .../LINALG/INV/a1-[autogen]/docstring.json | 17 + .../MATRIX_POWER/a1-[autogen]/docstring.json | 22 ++ .../LINALG/PINV/a1-[autogen]/docstring.json | 32 ++ .../LINALG/QR/a1-[autogen]/docstring.json | 27 ++ .../SLOGDET/a1-[autogen]/docstring.json | 22 ++ .../LINALG/SVD/a1-[autogen]/docstring.json | 42 +++ .../TENSORINV/a1-[autogen]/docstring.json | 22 ++ .../ARGRELMAX/a1-[autogen]/docstring.json | 32 ++ .../ARGRELMIN/a1-[autogen]/docstring.json | 32 ++ .../BSPLINE/a1-[autogen]/docstring.json | 31 ++ .../SIGNAL/CUBIC/a1-[autogen]/docstring.json | 17 + .../DECIMATE/a1-[autogen]/docstring.json | 47 +++ .../DETREND/a1-[autogen]/docstring.json | 37 +++ .../GAUSS_SPLINE/a1-[autogen]/docstring.json | 22 ++ .../HILBERT/a1-[autogen]/docstring.json | 27 ++ .../KAISER_BETA/a1-[autogen]/docstring.json | 17 + .../PERIODOGRAM/a1-[autogen]/docstring.json | 57 ++++ .../QUADRATIC/a1-[autogen]/docstring.json | 17 + .../SAVGOL_FILTER/a1-[autogen]/docstring.json | 52 +++ .../SIGNAL/STFT/a1-[autogen]/docstring.json | 82 +++++ .../SIGNAL/WELCH/a1-[autogen]/docstring.json | 77 +++++ .../ANDERSON/a1-[autogen]/docstring.json | 27 ++ .../BAYES_MVS/a1-[autogen]/docstring.json | 22 ++ .../BINOM_TEST/a1-[autogen]/docstring.json | 32 ++ .../DESCRIBE/a1-[autogen]/docstring.json | 42 +++ .../STATS/GSTD/a1-[autogen]/docstring.json | 27 ++ .../STATS/GZSCORE/a1-[autogen]/docstring.json | 32 ++ .../JARQUE_BERA/a1-[autogen]/docstring.json | 22 ++ .../KURTOSIS/a1-[autogen]/docstring.json | 42 +++ .../KURTOSISTEST/a1-[autogen]/docstring.json | 42 +++ .../STATS/MOMENT/a1-[autogen]/docstring.json | 37 +++ .../STATS/MVSDIST/a1-[autogen]/docstring.json | 22 ++ .../NORMALTEST/a1-[autogen]/docstring.json | 32 ++ .../STATS/SEM/a1-[autogen]/docstring.json | 32 ++ .../STATS/SHAPIRO/a1-[autogen]/docstring.json | 22 ++ .../SIGMACLIP/a1-[autogen]/docstring.json | 32 ++ .../STATS/SKEW/a1-[autogen]/docstring.json | 37 +++ .../SKEWTEST/a1-[autogen]/docstring.json | 42 +++ .../STATS/TMAX/a1-[autogen]/docstring.json | 37 +++ .../STATS/TMIN/a1-[autogen]/docstring.json | 37 +++ .../STATS/TRIM1/a1-[autogen]/docstring.json | 32 ++ .../TRIMBOTH/a1-[autogen]/docstring.json | 27 ++ .../TRIM_MEAN/a1-[autogen]/docstring.json | 27 ++ .../TTEST_1SAMP/a1-[autogen]/docstring.json | 47 +++ .../VARIATION/a1-[autogen]/docstring.json | 37 +++ .../YEOJOHNSON/a1-[autogen]/docstring.json | 22 ++ .../STATS/ZSCORE/a1-[autogen]/docstring.json | 32 ++ .../ABS/a1-[autogen]/docstring.json | 11 + .../ADD/a1-[autogen]/docstring.json | 11 + .../DIVIDE/a1-[autogen]/docstring.json | 11 + .../MULTIPLY/a1-[autogen]/docstring.json | 11 + .../SUBTRACT/a1-[autogen]/docstring.json | 11 + .../DIFFERENTIATE/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 37 +++ .../a1-[autogen]/docstring.json | 22 ++ .../examples/EX1/app.json | 311 +++++++----------- .../INTEGRATE/a1-[autogen]/docstring.json | 11 + .../CHANNEL_MERGE/a1-[autogen]/docstring.json | 11 + .../CHANNEL_SPLIT/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 5 + .../a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 17 + .../DOT_PRODUCT/a1-[autogen]/docstring.json | 11 + .../INVERT/a1-[autogen]/docstring.json | 17 + .../MATMUL/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 17 + .../SORT_MATRIX/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.txt | 11 + .../a1-[autogen]/docstring.json | 11 + .../BUTTER/a1-[autogen]/docstring.json | 32 ++ .../FFT/a1-[autogen]/docstring.json | 37 +++ .../FIR/a1-[autogen]/docstring.json | 42 +++ .../IFFT/a1-[autogen]/docstring.json | 17 + .../PID/a1-[autogen]/docstring.json | 27 ++ .../SAVGOL/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 32 ++ .../TEXT_CONCAT/a1-[autogen]/docstring.json | 17 + .../DF_2_NP/a1-[autogen]/docstring.json | 11 + .../DF_2_NP/examples/EX1/app.json | 235 +++++-------- .../a1-[autogen]/docstring.json | 27 ++ .../DF_2_ORDERED_TRIPLE/examples/EX1/app.json | 273 ++++++--------- .../a1-[autogen]/docstring.txt | 11 + .../MAT_2_DF/a1-[autogen]/docstring.json | 11 + .../NP_2_DF/a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.txt | 18 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 11 + .../a1-[autogen]/docstring.json | 27 ++ .../a1-[autogen]/docstring.json | 11 + .../SHIFT_VECTOR/a1-[autogen]/docstring.json | 17 + .../a1-[autogen]/docstring.json | 11 + .../SORT_VECTOR/a1-[autogen]/docstring.json | 17 + .../SPLIT_VECTOR/a1-[autogen]/docstring.json | 17 + .../VECTOR_DELETE/a1-[autogen]/docstring.json | 22 ++ .../a1-[autogen]/docstring.json | 17 + .../VECTOR_INSERT/a1-[autogen]/docstring.json | 22 ++ .../VECTOR_LENGTH/a1-[autogen]/docstring.json | 11 + .../VECTOR_MAX/a1-[autogen]/docstring.json | 11 + .../VECTOR_MIN/a1-[autogen]/docstring.json | 11 + .../VECTOR_SUBSET/a1-[autogen]/docstring.json | 22 ++ .../ARRAY_VIEW/a1-[autogen]/docstring.json | 11 + .../MATRIX_VIEW/a1-[autogen]/docstring.json | 11 + .../TEXT_VIEW/a1-[autogen]/docstring.json | 11 + .../PLOTLY/BAR/a1-[autogen]/docstring.json | 11 + .../BIG_NUMBER/a1-[autogen]/docstring.json | 32 ++ .../COMPOSITE/a1-[autogen]/docstring.json | 22 ++ .../HEATMAP/a1-[autogen]/docstring.json | 22 ++ .../HISTOGRAM/a1-[autogen]/docstring.json | 11 + .../PLOTLY/IMAGE/a1-[autogen]/docstring.json | 11 + .../PLOTLY/LINE/a1-[autogen]/docstring.json | 11 + .../PLOTLY/LINE/examples/EX1/app.json | 238 +++++--------- .../a1-[autogen]/docstring.json | 17 + .../PROPHET_PLOT/a1-[autogen]/docstring.json | 17 + .../SCATTER/a1-[autogen]/docstring.json | 11 + .../SCATTER3D/a1-[autogen]/docstring.json | 11 + .../SURFACE3D/a1-[autogen]/docstring.json | 11 + .../PLOTLY/TABLE/a1-[autogen]/docstring.json | 11 + .../PLOTLY/TABLE/examples/EX1/app.json | 202 ++++-------- nodeSidebar.json | 11 +- 234 files changed, 5468 insertions(+), 834 deletions(-) create mode 100644 docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/a1-[autogen]/docstring.json create mode 100644 docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/FILE/READ_CSV/a1-[autogen]/docstring.json create mode 100644 docs/nodes/EXTRACTORS/FILE/READ_S3/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/MATRIX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/POPULATE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/RAND/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/SCALAR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/SINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/TEXT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/IMAGING/OPEN_WEBCAM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/IMAGING/WEBCAM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/PROTOCOLS/SCPI/IDN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/LOOPS/APPEND/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/LOOPS/LOOP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/LOGIC_GATES/TIMERS/TIMER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/CHOLESKY/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/DET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/EIG/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/EIGH/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/EIGVALS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/EIGVALSH/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/INV/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/MATRIX_POWER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/PINV/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/QR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/SLOGDET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/SVD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/NUMPY/LINALG/TENSORINV/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/ARGRELMAX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/ARGRELMIN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/BSPLINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/CUBIC/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/DECIMATE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/DETREND/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/HILBERT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/KAISER_BETA/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/QUADRATIC/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/STFT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/SIGNAL/WELCH/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/ANDERSON/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/BAYES_MVS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/BINOM_TEST/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/DESCRIBE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/GSTD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/GZSCORE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/JARQUE_BERA/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/KURTOSIS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/KURTOSISTEST/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/MOMENT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/MVSDIST/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/NORMALTEST/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/SEM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/SHAPIRO/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/SIGMACLIP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/SKEW/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/SKEWTEST/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TMAX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TMIN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TRIM1/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TRIMBOTH/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TRIM_MEAN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/TTEST_1SAMP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/VARIATION/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/YEOJOHNSON/a1-[autogen]/docstring.json create mode 100644 docs/nodes/SCIPY/STATS/ZSCORE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/TRANSPOSE_MATRIX/a1-[autogen]/docstring.txt create mode 100644 docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/MATRIX_2_VECTOR/a1-[autogen]/docstring.txt create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_MATRIX/a1-[autogen]/docstring.txt create mode 100644 docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/a1-[autogen]/docstring.json create mode 100644 docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/BAR/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/IMAGE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/LINE/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/SCATTER/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/a1-[autogen]/docstring.json create mode 100644 docs/nodes/VISUALIZERS/PLOTLY/TABLE/a1-[autogen]/docstring.json diff --git a/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..df0342864d --- /dev/null +++ b/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "These dataframes should both be single columns.", + "parameters": [ + { + "name": "true_label", + "type": "optional str", + "description": "true label users can select from original data" + }, + { + "name": "predicted_label", + "type": "optional str", + "description": "resulting predicted label users can select" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "The input predictions dataframe, with an extra boolean column \"prediction_correct\"." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..804e2564d4 --- /dev/null +++ b/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndata : DataFrame\n The input dataframe containing the categorical features.", + "parameters": [ + { + "name": "feature_col", + "type": "DataFrame", + "description": "A dataframe whose columns are used to create the one hot encoding.\nFor example, if 'data' has columns ['a', 'b', 'c'] and 'feature_col' has columns ['a', 'b'],\nthen the one hot encoding will be created only for columns ['a', 'b'] against 'data'.\nDefaults to None, meaning that all columns of categorizable objects are encoded." + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "The one hot encoding of the input features." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8e5157531d --- /dev/null +++ b/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "It takes two dataframes of label and feature from labelled training data and a dataframe of unlabelled input data.", + "parameters": [ + { + "name": "kernel", + "type": "'linear' | 'poly' | 'rbf' | 'sigmoid' | 'precomputed'", + "description": "Specifies the kernel type to be used in the algorithm.\nFor detailed information about kernel types:\nhttps://scikit-learn.org/stable/modules/svm.html#kernel-functions" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "The predictions for the input data." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..96c5da03b6 --- /dev/null +++ b/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/a1-[autogen]/docstring.json @@ -0,0 +1,26 @@ +{ + "description": "Inputs\n----------\ninput_image : Image\n The image to classify.\nclass_names : DataFrame\n A dataframe containing the class names.", + "parameters": [ + { + "name": "model_path", + "type": "str", + "description": "The path to the torchscript model." + }, + { + "name": "Returns", + "type": null, + "description": null + }, + { + "name": "----------", + "type": null, + "description": null + }, + { + "name": "DataFrame", + "type": null, + "description": "A dataframe containing the class name and confidence score." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..43fd6809b8 --- /dev/null +++ b/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": null, + "parameters": [ + { + "name": "test_size", + "type": "float", + "description": "The size of testing data specified." + } + ], + "returns": [ + { + "name": "train", + "type": "DataFrame", + "description": "A dataframe of training data." + }, + { + "name": "test", + "type": "DataFrame", + "description": "A dataframe of test data." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..92e32e5747 --- /dev/null +++ b/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "DataFrame containing the caption column and a single row." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c2a7b193c0 --- /dev/null +++ b/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "For more information about Vision Transformers,\nsee: https://huggingface.co/google/vit-base-patch16-224\n\nFor a complete list of models, see:\nhttps://huggingface.co/models?pipeline_tag=image-classification\n\nFor examples of how revision parameters (such as 'main') is used,\nsee: https://huggingface.co/google/vit-base-patch16-224/commits/main", + "parameters": [ + { + "name": "default", + "type": "Image", + "description": "The input image to be classified.\nThe image must be a PIL.Image object, wrapped in a Flojoy Image object." + }, + { + "name": "model", + "type": "str", + "description": "The model to be used for classification.\nIf not specified, Vision Transformers (i.e. 'google/vit-base-patch16-224') are used." + }, + { + "name": "revision", + "type": "str", + "description": "The revision of the model to be used for classification.\nIf not specified, 'main' is used." + } + ], + "returns": [ + { + "name": "DataFrame", + "type": "", + "description": "A DataFrame containing the columns 'label' (as classification label)\nand 'score' (as the confidence score).\nAll scores are between 0 and 1, and sum to 1." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f3294512da --- /dev/null +++ b/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "This allows supporting a wide range of deep learning frameworks and hardware platforms.", + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "Path to a ONNX model to load and use for prediction." + }, + { + "name": "default", + "type": "Vector", + "description": "The input tensor to use for prediction.\nFor now, only a single input tensor is supported.\nNote that the input tensor shape is not checked against the model's input shape." + } + ], + "returns": [ + { + "name": "Vector", + "type": "", + "description": "The predictions made by the ONNX model.\nFor now, only a single output tensor is supported." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..43ec5dd8bd --- /dev/null +++ b/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": "tokens", + "type": "DataFrame", + "description": "Holds all the unique tokens observed from the input." + }, + { + "name": "word_count_vector", + "type": "Vector", + "description": "Contains the occurences of these tokens from each sentence." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..aea85d72a3 --- /dev/null +++ b/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Image", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Image", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..dbcde4df6e --- /dev/null +++ b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The DataContainer input type must be a dataframe, and the first column (or index) of the dataframe must be of a datetime type.\n\nThis node always returns a DataContainer of a dataframe type. It will also always return an 'extra' field with a key 'prophet' of which the value is the JSONified Prophet model.\nThis model can be loaded as follows:\n\n ```python\n from prophet.serialize import model_from_json\n\n model = model_from_json(dc_inputs.extra[\"prophet\"])\n ```", + "parameters": [ + { + "name": "run_forecast", + "type": "bool", + "description": "If True (default case), the dataframe of the returning DataContainer\n('m' parameter of the DataContainer) will be the forecasted dataframe.\nIt will also have an 'extra' field with the key 'original', which is\nthe original dataframe passed in.\n\nIf False, the returning dataframe will be the original data.\n\nThis node will also always have an 'extra' field, run_forecast, which\nmatches that of the parameters passed in. This is for future nodes\nto know if a forecast has already been run.\n\nDefault = True" + }, + { + "name": "periods", + "type": "int", + "description": "The number of periods to predict out. Only used if run_forecast is True.\nDefault = 365" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "With parameter as df.\nIndicates either the original df passed in, or the forecasted df\n(depending on if run_forecast is True)." + }, + { + "name": null, + "type": "DataContainer", + "description": "With parameter as 'extra'.\nContains keys run_forecast which correspond to the input parameter,\nand potentially 'original' in the event that run_forecast is True." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..47dbc8e966 --- /dev/null +++ b/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: input matrix (data points)\ny: fitted line computed with returned regression weights" + }, + { + "name": null, + "type": "Matrix", + "description": "m: fitted matrix computed with returned regression weights" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..75d0371687 --- /dev/null +++ b/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "The input image is expected to be a DataContainer of an 'image' type.\n\nThe output is a DataContainer of an 'image' type with the same dimensions as the input image, but with the red, green, and blue channels replaced with the segmentation mask.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Image", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/a1-[autogen]/docstring.json b/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..0107a1ffc1 --- /dev/null +++ b/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "The \"summary_text\" column contains a summary of the text in the corresponding row of the input dataframe.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "dataframe containing the summary text in the \"summary_text\" column" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d4f40ca827 --- /dev/null +++ b/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault : DataFrame|Matrix\n Input to use as the table for column extraction", + "parameters": [ + { + "name": "columns", + "type": "list of str or list of int", + "description": "The columns to extract from the input dataframe" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame|Matrix", + "description": "DataFrame or Matrix with only the specified columns" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1dbbede8ab --- /dev/null +++ b/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Must use the TEXT_VIEW node to view the text.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Input DataContainer type" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ecd8393f28 --- /dev/null +++ b/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Must use the TEXT_VIEW node to view the text.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Type of the input DataContainer's content (e.g. float)" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..0ab5d4176a --- /dev/null +++ b/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Must use the TEXT_VIEW node to view the text.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Input datacontainer information" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..71a04cc5f9 --- /dev/null +++ b/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault: None", + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "path to the file to be loaded" + } + ], + "returns": [ + { + "name": null, + "type": "Image", + "description": "Image loaded from specified file path" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b8aedc57dc --- /dev/null +++ b/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault: None", + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "File path to the .parquet file or an URL of a .parquet file." + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "DataFrame loaded from .parquet file" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/FILE/READ_CSV/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/FILE/READ_CSV/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..91c5231328 --- /dev/null +++ b/docs/nodes/EXTRACTORS/FILE/READ_CSV/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "File path to the .csv file or an URL of a .csv file." + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "DataFrame loaded from .csv file" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/EXTRACTORS/FILE/READ_S3/a1-[autogen]/docstring.json b/docs/nodes/EXTRACTORS/FILE/READ_S3/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3c47d804a3 --- /dev/null +++ b/docs/nodes/EXTRACTORS/FILE/READ_S3/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Inputs\n------\ndefault: None", + "parameters": [ + { + "name": "s3_name", + "type": "str", + "description": "name of the key that the user used to save the access and secret access keys" + }, + { + "name": "bucket_name", + "type": "str", + "description": "Amazon S3 bucket name that they are trying to access" + }, + { + "name": "file_name", + "type": "str", + "description": "name of the file that they want to extract" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "DataFrame loaded from file in the specfied bucket" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e978780610 --- /dev/null +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "dataset_key", + "type": "str", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8d1a472cd2 --- /dev/null +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "'sklearn.datasets', using the provided dataset_key parameter, and returns\nit wrapped in a DataContainer.", + "parameters": [ + { + "name": "dataset_name", + "type": "str", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "A DataContainer object containing the retrieved pandas DataFrame." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a897b92e1e --- /dev/null +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The data is returned as a dataframe with one column containing the text and the other containing the category.", + "parameters": [ + { + "name": "subset", + "type": "\"train\" | \"test\" | \"all\", default=\"train\"", + "description": "Select the dataset to load: \"train\" for the training set, \"test\" for the test set, \"all\" for both." + }, + { + "name": "categories", + "type": "list of str", + "description": "Select the categories to load. By default, all categories are loaded.\nThe list of all categories is:\n'alt.atheism',\n'comp.graphics',\n'comp.os.ms-windows.misc',\n'comp.sys.ibm.pc.hardware',\n'comp.sys.mac.hardware',\n'comp.windows.x',\n'misc.forsale',\n'rec.autos',\n'rec.motorcycles',\n'rec.sport.baseball',\n'rec.sport.hockey',\n'sci.crypt',\n'sci.electronics',\n'sci.med',\n'sci.space',\n'soc.religion.christian',\n'talk.politics.guns',\n'talk.politics.mideast',\n'talk.politics.misc',\n'talk.religion.misc'" + }, + { + "name": "remove_headers", + "type": "boolean, default=false", + "description": "Remove the headers from the data." + }, + { + "name": "remove_footers", + "type": "boolean, default=false", + "description": "Remove the footers from the data." + }, + { + "name": "remove_quotes", + "type": "boolean, default=false", + "description": "Remove the quotes from the data." + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..40f999fc27 --- /dev/null +++ b/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Examples can be found here:\nhttps://scikit-image.org/docs/stable/auto_examples/index.html", + "parameters": [ + { + "name": "img_key", + "type": "str", + "description": "The name of the image to be loaded from scikit-image." + } + ], + "returns": [ + { + "name": null, + "type": "Image", + "description": "DataContainer containing the image loaded from scikit-image." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..039afcec73 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/a1-[autogen]/docstring.json @@ -0,0 +1,47 @@ +{ + "description": "It offers a more straightforward way to generate signals, with sample rate and the time in seconds as parameters, along with all the parameters in the SINE node.", + "parameters": [ + { + "name": "sample_rate", + "type": "float", + "description": "The number of samples that are taken in a second." + }, + { + "name": "time", + "type": "float", + "description": "The total amount of time of the signal." + }, + { + "name": "waveform", + "type": "select", + "description": "The waveform type of the wave." + }, + { + "name": "amplitude", + "type": "float", + "description": "The amplitude of the wave." + }, + { + "name": "frequency", + "type": "float", + "description": "The wave frequency in radians/2pi." + }, + { + "name": "offset", + "type": "float", + "description": "The y axis offset of the function." + }, + { + "name": "phase", + "type": "float", + "description": "The x axis offset of the function." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: time domain\ny: generated signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..eac83faeeb --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Vector\n Optional input that defines the size of the output.", + "parameters": [ + { + "name": "dc_type", + "type": "select", + "description": "The type of DataContainer to return." + }, + { + "name": "constant", + "type": "float", + "description": "The value of the y axis output." + }, + { + "name": "step", + "type": "int", + "description": "The size of the y and x axes." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair|Vector|Scalar", + "description": "OrderedPair if selected\nx: the x axis generated with size 'step'\ny: the resulting constant with size 'step'\nVector if selected\nv: the resulting constant with size 'step'\nScalar if selected\nc: the resulting constant" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..01292afb02 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [ + { + "name": "referred_node", + "type": "str", + "description": "The node ID to capture the result from." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d6faafc1e7 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "It uses the 'linspace' numpy function. It is useful for generating an x-axis for the OrderedPair data type.\n\nInputs\n------\ndefault : OrderedPair\n Optional input in case LINSPACE is used in a loop. Not used.", + "parameters": [ + { + "name": "start", + "type": "float", + "description": "The start point of the data." + }, + { + "name": "end", + "type": "float", + "description": "The end point of the data." + }, + { + "name": "step", + "type": "float", + "description": "The number of points in the vector." + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "v: the vector between 'start' and 'end' with a 'step' number of points." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2d4505f73c --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Based on these inputs, it generates a random matrix where the integers inside the matrix are between 0 and 19.", + "parameters": [ + { + "name": "row", + "type": "int", + "description": "number of rows" + }, + { + "name": "column", + "type": "int", + "description": "number of columns" + } + ], + "returns": [ + { + "name": null, + "type": "matrix", + "description": "randomly generated matrix" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..60a5834c94 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Vector\n Input to use as the x-axis for the random samples.", + "parameters": [ + { + "name": "distribution", + "type": "select", + "description": "the distribution over the random samples" + }, + { + "name": "lower_bound", + "type": "float", + "description": "the lower bound of the output interval" + }, + { + "name": "upper_bound", + "type": "float", + "description": "the upper bound of the output interval" + }, + { + "name": "normal_mean", + "type": "float", + "description": "the mean or \"center\" of the normal distribution" + }, + { + "name": "normal_standard_deviation", + "type": "float", + "description": "the spread or \"width\" of the normal distribution" + }, + { + "name": "poisson_events", + "type": "float", + "description": "the expected number of events occurring in a fixed time-interval when distribution is poisson" + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: provided from input data\ny: the random samples" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/RAND/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/RAND/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4c45604ddd --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/RAND/a1-[autogen]/docstring.json @@ -0,0 +1,47 @@ +{ + "description": "Inputs\n------\ndefault : DataContainer\n unused in this node", + "parameters": [ + { + "name": "distribution", + "type": "select", + "description": "the distribution over the random samples" + }, + { + "name": "size", + "type": "int", + "description": "the size of the output. =1 outputs Scalar, >1 outputs Vector" + }, + { + "name": "lower_bound", + "type": "float", + "description": "the lower bound of the output interval" + }, + { + "name": "upper_bound", + "type": "float", + "description": "the upper bound of the output interval" + }, + { + "name": "normal_mean", + "type": "float", + "description": "the mean or \"center\" of the normal distribution" + }, + { + "name": "normal_standard_deviation", + "type": "float", + "description": "the spread or \"width\" of the normal distribution" + }, + { + "name": "poisson_events", + "type": "float", + "description": "the expected number of events occurring in a fixed time-interval when distribution is poisson" + } + ], + "returns": [ + { + "name": null, + "type": "Scalar|Vector", + "description": "Vector if size > 1\nv: the random samples\n\nScalar if size = 1\nc: the random number" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..80c3fec03d --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "value", + "type": "float", + "description": "The value set in Parameters" + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "c: return the value being set in Parameters" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..417c9a691d --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "This node is designed to be used in a loop. The data is appended as the loop progresses and written to memory.\n\nInputs\n------\ndefault : Scalar\n PID node output.", + "parameters": [ + { + "name": "d1", + "type": "float", + "description": "The first time constant." + }, + { + "name": "d2", + "type": "float", + "description": "The second time constant." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The most recent value of the second order function." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SINE/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/SINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bd8a9fe517 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/SINE/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Vector\n Input that defines the x-axis values of the function and output.", + "parameters": [ + { + "name": "waveform", + "type": "select", + "description": "The waveform type of the wave." + }, + { + "name": "amplitude", + "type": "float", + "description": "The amplitude of the wave." + }, + { + "name": "frequency", + "type": "float", + "description": "The wave frequency in radians/2pi." + }, + { + "name": "offset", + "type": "float", + "description": "The y axis offset of the function." + }, + { + "name": "phase", + "type": "float", + "description": "The x axis offset of the function." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: the input v or x values\ny: the resulting sine function" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/TEXT/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/TEXT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..369cd827e5 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/TEXT/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "value", + "type": "str", + "description": "The value set in Parameters." + } + ], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": "Return the value being set in Parameters." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..60d0966911 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": null, + "parameters": [ + { + "name": "start_date", + "type": "str", + "description": "The start date of the timeseries in the format 'YYYY:MM:DD'." + }, + { + "name": "end_date", + "type": "str", + "description": "The end date of the timeseries in the format 'YYYY:MM:DD'." + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "m: the resulting timeseries" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..df6c7addab --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "If a Scalar input is provided, the Scalar is returned with the timestamp as an OrderedPair.\n\nInputs\n------\ndefault : Scalar\n A value to timestamp", + "parameters": [ + { + "name": "dc_type", + "type": "select", + "description": "The type of DataContainer to return." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar|Vector|OrderedPair", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/a1-[autogen]/docstring.json b/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1eed8906b0 --- /dev/null +++ b/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "This example uses the Crank-Nicolson Method to solve the 1D Schrodinger equation.\n\nFurther reading:\nhttp://staff.ustc.edu.cn/~zqj/posts/Numerical_TDSE/", + "parameters": [ + { + "name": "L_box", + "type": "float", + "description": "The width of the box in Bohr lengths." + }, + { + "name": "center", + "type": "float", + "description": "The center of the initial wavepacket." + }, + { + "name": "momentum", + "type": "float", + "description": "The momentum of the initial wavepacket." + }, + { + "name": "sigma", + "type": "float", + "description": "The width of the initial wavepacket." + }, + { + "name": "dt", + "type": "float", + "description": "Time steps in atomic units, 1 a.u. = 24.188 as." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "The most recent wavepacket." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/a1-[autogen]/docstring.json b/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..906ed6a16d --- /dev/null +++ b/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": null, + "parameters": [ + { + "name": "Calibration1", + "type": "float", + "description": "Calibration parameters to convert voltage into pressure." + }, + { + "name": "calibration2", + "type": "float", + "description": "Calibration parameters to convert voltage into pressure." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/a1-[autogen]/docstring.json b/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ee49fd85e2 --- /dev/null +++ b/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [ + { + "name": "Calibration1, Calibration2, Calibration3", + "type": "float", + "description": "Calibration parameters to convert voltage into temperature in Celcius." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/IMAGING/OPEN_WEBCAM/a1-[autogen]/docstring.json b/docs/nodes/IO/IMAGING/OPEN_WEBCAM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..af5cdf42aa --- /dev/null +++ b/docs/nodes/IO/IMAGING/OPEN_WEBCAM/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": null, + "parameters": [ + { + "name": "camera", + "type": "Camera", + "description": "The camera to use." + }, + { + "name": "resolution", + "type": "select", + "description": "Camera resolution. Choose from a few options." + } + ], + "returns": [ + { + "name": null, + "type": "None", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/IMAGING/WEBCAM/a1-[autogen]/docstring.json b/docs/nodes/IO/IMAGING/WEBCAM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d141e2b5ac --- /dev/null +++ b/docs/nodes/IO/IMAGING/WEBCAM/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The selected camera must be opened already using the OPEN_WEBCAM node.", + "parameters": [ + { + "name": "connection", + "type": "Camera", + "description": "The opened camera connection to use." + }, + { + "name": "resolution", + "type": "select", + "description": "Camera resolution. Choose from a few options." + } + ], + "returns": [ + { + "name": null, + "type": "Image", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..52b6136e3d --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "When setting the attenuation, the attenuation is then queried to ensure\nthe attenuation was set correctly.\nThe attenuation is rounded to the nearest 0.5 dB.\n\nThis node should also work with compatible LDA attenuators (untested).", + "parameters": [ + { + "name": "serial_number", + "type": "str", + "description": "The serial number (not model number) to connect to." + }, + { + "name": "query_set", + "type": "str", + "description": "Query or set the attenuation?" + }, + { + "name": "attenuation", + "type": "str", + "description": "The attenuation to set the LDA to, in dB." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: The current attenuation value." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a61b196e25 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "The SENSOR node can be used to convert voltage into temperature measurements.", + "parameters": [ + { + "name": "number", + "type": "int", + "description": "Defines the number of temperature sensors connected to the LabJack U3 device." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f0d9fffece --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [ + { + "name": "n_sensors", + "type": "int", + "description": "Defines the number of pressure sensors connected to the Phidget InterfaceKit." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1f6fbdb153 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,62 @@ +{ + "description": "You can set various settings for the triggering of the bursts as well.\nThe burst mode is way to have signals come in \"bursts\" that are triggered\nexternally or with a timer for instance.\n\nRequires a CONNECTION_33510B node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "on_off", + "type": "str", + "description": "Turn the burst mode on or off." + }, + { + "name": "channel", + "type": "str", + "description": "The channel to modify the burst mode for." + }, + { + "name": "trigger_source", + "type": "str", + "description": "Set the trigger_source (e.g. externally or timed)." + }, + { + "name": "trigger_delay", + "type": "float", + "description": "Delay the burst by this number of seconds after a trigger." + }, + { + "name": "trigger_slope", + "type": "str", + "description": "If triggering is external, trigger on a positive or negative slope." + }, + { + "name": "burst_mode", + "type": "str", + "description": "Set the burst mode for the WFG." + }, + { + "name": "burst_ncycles", + "type": "int", + "description": "How many cycles to have in one burst." + }, + { + "name": "burst_phase", + "type": "float", + "description": "What phase to start the burst with, in degrees." + }, + { + "name": "burst_polarity", + "type": "str", + "description": "The polarity of the burst in Gated mode, normal or inverted." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: summary of burst mode settings." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..264493bc9c --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Error retrival is first-in-first-out (FIFO). Returning errors clears them\nfrom the instruments queue.\n\nRequires a CONNECTION_33510B node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Returns all errors in the WFG memory." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..86a7e314c8 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The connection is made with the VISA address in the Flojoy UI.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "device", + "type": "VisaDevice", + "description": "The VISA address to connect to." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Optional: None" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7e4adbf912 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Requires a CONNECTION_33510B node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "on_off", + "type": "str", + "description": "Whether to turn the waveform generation to on or off." + }, + { + "name": "channel", + "type": "str", + "description": "The channel to turn on or off." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: ON or OFF depending on on_off value." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a2fc0a940c --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Can only be turned on for one channel.\n\nRequires a CONNECTION_33510B node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "on_off", + "type": "str", + "description": "Whether to turn the waveform phase syncing on or off." + }, + { + "name": "channel", + "type": "str", + "description": "The channel to use as the baseline phase." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: The channel, and ON or OFF depending on on_off value." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b90cc315be --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/a1-[autogen]/docstring.json @@ -0,0 +1,72 @@ +{ + "description": "The Keysight 33510B has a variety of waveform settings available.\n\nRequires a CONNECTION_33510B node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Keysight 33XXX wavefunction\ngenerators (although they are untested).", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "on_off", + "type": "str", + "description": "Whether to turn the waveform generation to on or off." + }, + { + "name": "query_set", + "type": "str", + "description": "Whether to query or set the waveform." + }, + { + "name": "channel", + "type": "str", + "description": "The channel to set or query." + }, + { + "name": "waveform", + "type": "str", + "description": "The type of waveform to use." + }, + { + "name": "frequency", + "type": "float", + "description": "The voltage of the waveform to set, in Hz." + }, + { + "name": "amplitude", + "type": "float", + "description": "The voltage of the waveform to set." + }, + { + "name": "amplitude_unit", + "type": "str", + "description": "The voltage unit to set the waveform to." + }, + { + "name": "phase", + "type": "float", + "description": "The phase to set the waveform to, in degrees." + }, + { + "name": "offset", + "type": "float", + "description": "The voltage offset to set the waveform to, in volts." + }, + { + "name": "ramp_symmetry", + "type": "float", + "description": "The ramp symmetry if the RAMP waveform is used, in percent." + }, + { + "name": "pulse_width", + "type": "float", + "description": "The pulse width in nanoseconds if the PULS waveform is used." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Summary of waveform generator settings." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3bcf8d2925 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Note: This node is for testing purposes only.", + "parameters": [ + { + "name": "attenuation", + "type": "int", + "description": "Value at which the instrument would attenuate the input signal (mocked)." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "c: attenuation value" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..77135bcc16 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "current_limit", + "type": "str", + "description": "The maximum current to allow, in Amps." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The AC current reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..821e66224e --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "voltage_limit", + "type": "str", + "description": "The maximum voltage to allow, in Volts." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The AC voltage reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3e630d0e12 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Optional: None" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..69f2f7da35 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "current_limit", + "type": "str", + "description": "The maximum current to allow, in Amps." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The DC current reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7f9b67d0be --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "voltage_limit", + "type": "str", + "description": "The maximum voltage to allow, in Volts." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The DC voltage reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7f9b67d0be --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "voltage_limit", + "type": "str", + "description": "The maximum voltage to allow, in Volts." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The DC voltage reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..95bbcfe242 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The four-wire resistance is more accurate than two-wire and can be measured\nwith the FOUR_WIRE_RESIST_USB4065 node.\n\nThe USB-4065 is a NI (National Instruments) multimeter. It is possible that\nthe node will work with other NI DMMs (digital multimeters) such as the\n4070 and 4080 series.\n\nThis instrument will likely only be compatible with Windows systems due to\nNI driver availablity. To use the instrument you must install the runtime:\n\nhttps://www.ni.com/en/support/downloads/drivers/download.ni-dmm.html\n\nYou must also find the address/resource name for the instrument. You can\nfind this using the NI MAX programming which can be downloaded when\ninstalling the drivers.", + "parameters": [ + { + "name": "NI_address", + "type": "str", + "description": "The NI instrument address for the instrument (e.g. 'Dev0', 'Dev1')." + }, + { + "name": "digits", + "type": "str", + "description": "The accuracy of the reading in digits. Lower values are faster." + }, + { + "name": "resist_limit", + "type": "str", + "description": "The maximum resistance to allow, in Volts." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The DC voltage reading." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5704c3ad8f --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "This node is similar to MEASUREMENTS_MDO3XXX node but more measurements\nare availble. The available measurements are as follows:\n\namplitude, area, burst, carea, cmean, crms, delay, distduty, extinctdb,\nextinctpct, extinctratio, eyeheight, eyewidth, fall, frequency, high, hits,\nlow, maximum, mean, median, minimum, ncross, nduty, novershoot, nwidth,\npbase, pcross, pctcross, pduty, peakhits, period, phase, pk2pk, pkpkjitter,\npkpknoise, povershoot, ptop, pwidth, qfactor, rise, rms, rmsjitter,\nrmsnoise, sigma1, sigma2, sigma3, sixsigmajit, snratio, stddev, undefined,\nwaveforms\n\nAlso available are 5 statistic modes:\ninstant, mean, max, min, and stdev where instant is a single measurement\nand stdev is the standard deviation of the mean.\n\nRequires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx. Many of the advanced measurements are likely\nto not function with different model numbers.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "channel", + "type": "int", + "description": "The channel with which to create a measurement for." + }, + { + "name": "measurement", + "type": "str", + "description": "The measurement to make." + }, + { + "name": "statistic", + "type": "str", + "description": "The type of statistic to take for the measurement." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The measurement from the oscilloscope channel." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8d4fd381ee --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "Note that \"unchanged\" will leave the settings unchanged.\n\nRequires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "query_set", + "type": "str", + "description": "Whether to query or set the triggering channel." + }, + { + "name": "edge_couplings", + "type": "str", + "description": "Set the trigger edge coupling type." + }, + { + "name": "trigger_types", + "type": "str", + "description": "Set to trigger on edge, logic, or pulses." + }, + { + "name": "edge_slope", + "type": "str", + "description": "Set to trigger on positive, negative, or either slopes." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: Summary of trigger settings." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ff7d894145 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The connection is made with the VISA address in the Flojoy UI.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "device", + "type": "VisaDevice", + "description": "The VISA address to connect to." + }, + { + "name": "num_channels", + "type": "int", + "description": "The number of channels on the instrument that are currently in use." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Optional: None" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ec9b72ad74 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The number of points in the x axis is defined by x_length and length_type\nparameters. A length_type of pixels and a x_length of 5000 will result in\na trace with 5000 points. A length_type of nanoseconds instead results in\na trace with a length of defined by the number of (nano)seconds.\n\nRequires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "x_length", + "type": "int", + "description": "The length of the trace to extract." + }, + { + "name": "length_type", + "type": "select", + "description": "The units of the length specified in x_length: nanoseconds or pixels." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "OrderedPair: The trace of the oscilloscope is returned." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a636261335 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "This node can select from three different waveform measurements:\nfrequency, period, and amplitude. Also available are 5 statistic modes:\ninstant, mean, max, min, and stdev where instant is a single measurement\nand stdev is the standard deviation of the mean.\n\nUnits are in seconds, Hz, and V for frequency, period, and amplitude respectively.\n\nRequires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "measurement", + "type": "str", + "description": "The measurement to extract from the scope." + }, + { + "name": "statistic", + "type": "str", + "description": "The statistic mode to use for the measurement." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The waveform measurement in the selected statistic mode." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c87357245b --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Requires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "channel1", + "type": "int", + "description": "The first channel." + }, + { + "name": "channel2", + "type": "int", + "description": "The second channel." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The phase between the two channels." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..6a82e24819 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The termination is set by the output, and the set termination\nin the oscilloscope must match that value.\n\nNote that the termination is often called the \"electrical impedance\".\nNote that the 75 Ohm option is not compatible with all model numbers.\n\nIf the \"VISA_address\" parameter is not specified the VISA_index will be\nused to find the address. The LIST_VISA node can be used to show the\nindicies of all available VISA instruments.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "channel", + "type": "int", + "description": "The channel to query or set the impedance/termination." + }, + { + "name": "termination", + "type": "str", + "description": "The ohm to which the termination impedance is set to." + }, + { + "name": "query_set", + "type": "str", + "description": "Whether to query or set the triggering voltage." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The termination value for the chosen channel." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d9caa64279 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Requires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "channel", + "type": "int", + "description": "The channel to set as the triggering channel (used if set=True)." + }, + { + "name": "query_set", + "type": "str", + "description": "Whether to query or set the triggering channel." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "TextBlob: The triggering channel (e.g. CH1)." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..85d65da32b --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The trigger voltage is the level at which an oscilloscope will find the\nstart of a signal.\n\nRequires a CONNECTION_MDO3XXX node at the start of the app to connect with\nthe instrument. The VISA address will then be listed under 'connection'.\n\nThis node should also work with compatible Tektronix scopes (untested):\nMDO4xxx, MSO4xxx, and DPO4xxx.", + "parameters": [ + { + "name": "connection", + "type": "VisaConnection", + "description": "The VISA address (requires the CONNECTION_MDO3XXX node)." + }, + { + "name": "trigger_volts", + "type": "float", + "description": "The voltage to set the triggering level to." + }, + { + "name": "query_set", + "type": "str", + "description": "Whether to query or set the triggering voltage." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "Scalar: The triggering voltage." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4829315457 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "optional: The input DataContainer that is returned." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a721a86c59 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "optional: The input DataContainer is returned." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4ef7844d1e --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "If the \"VISA_address\" parameter is not specified the VISA_index will be\nused to find the address. The LIST_VISA node can be used to show the\nindicies of all available VISA instruments.", + "parameters": [ + { + "name": "VISA_address", + "type": "str", + "description": "The VISA address to query." + }, + { + "name": "VISA_index", + "type": "int", + "description": "The address will be found from LIST_VISA node list with this index." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "optional: The input DataContainer is returned." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2d730ffc9a --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault: OrderedPair | Vector\n The voltages to send to the Keithley 2400 source meter.", + "parameters": [ + { + "name": "connection", + "type": "Serial", + "description": "The open connection with the Keithley2400 source meter." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/a1-[autogen]/docstring.json b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ea9873ec30 --- /dev/null +++ b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "device", + "type": "Serial", + "description": "The connected serial device corresponding to the Keithley 2400 source meter." + } + ], + "returns": [ + { + "name": null, + "type": "None", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/a1-[autogen]/docstring.json b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..edde653427 --- /dev/null +++ b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/a1-[autogen]/docstring.json @@ -0,0 +1,21 @@ +{ + "description": "The user defines the speed and the sleep time between movements.\n\n(To choose the position, use the STEPPER_DRIVER_TIC_KNOB.)", + "parameters": [ + { + "name": "current_limit", + "type": "int", + "description": "Defines the current limitation that the stepper motor will receive." + }, + { + "name": "sleep_time", + "type": "int", + "description": "Defines the sleep time after moving to each position." + }, + { + "name": "speed", + "type": "int", + "description": "Defines the speed of the motor movement (between 0 and 200000)." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/a1-[autogen]/docstring.json b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..73ef385bb6 --- /dev/null +++ b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/a1-[autogen]/docstring.json @@ -0,0 +1,26 @@ +{ + "description": "The user controls the motor's rotation with the knob position, specified in the node's parameters.", + "parameters": [ + { + "name": "knob_value", + "type": "int", + "description": "Defines the position of the motor (rotational movement)." + }, + { + "name": "current_limit", + "type": "int", + "description": "Defines the current limitation that the stepper motor will receive." + }, + { + "name": "sleep_time", + "type": "int", + "description": "Defines the sleep time after moving to each position." + }, + { + "name": "speed", + "type": "int", + "description": "Defines the speed of the motor movement (between 0 and 200000)." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SCPI/IDN/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SCPI/IDN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..9518e493c0 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SCPI/IDN/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.", + "parameters": [ + { + "name": "connection", + "type": "Serial", + "description": "The open connection with the device receiving the *IDN? SCPI command." + } + ], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": "The result of the *IDN? SCPI command." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d1e98a2412 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault: DataContainer\n Any DataContainer - likely connected to the output of the OPEN_SERIAL node.", + "parameters": [ + { + "name": "connection", + "type": "Serial", + "description": "The open serial connection with the instrument." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar|TextBlob", + "description": "The measured voltage as a Scalar or an exception error as a TextBlob." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cb4bff4fb7 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "device", + "type": "Serial", + "description": "The connected serial device." + } + ], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b1d987e054 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": null, + "parameters": [ + { + "name": "baudrate", + "type": "int", + "description": "Baud rate for the serial communication." + }, + { + "name": "comport", + "type": "string", + "description": "Defines the comunication port on which the serial device is connected." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bbf5c0d639 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/a1-[autogen]/docstring.json @@ -0,0 +1,31 @@ +{ + "description": null, + "parameters": [ + { + "name": "num_readings", + "type": "int", + "description": "Number of points to record." + }, + { + "name": "record_period", + "type": "float", + "description": "Length between two recordings in seconds." + }, + { + "name": "baudrate", + "type": "int", + "description": "Baud rate for the serial device." + }, + { + "name": "comport", + "type": "string", + "description": "COM port of the serial device." + }, + { + "name": "num_readings * record_period", + "type": "", + "description": "Is roughly the run length in seconds." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..48b62ccf4f --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address: TextBlob\n The IP address of the robot arm.\n\nParameters\n------\nsimulator\n Whether to activate the simulator or not. Defaults to False.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..437866d8c5 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "String", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a33d802da4 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address: TextBlob\n The IP address of the robot arm.\n\ntime: float\n The time of delay in seconds.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bab6b13fe1 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/a1-[autogen]/docstring.json @@ -0,0 +1,5 @@ +{ + "description": "Inputs\n------\nip_address\n The IP address of the robot arm.", + "parameters": [], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..dc3ef89a92 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address\n The IP address of the robot arm.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c53fa42130 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address: TextBlob\n The IP address of the robot arm.\n\nParameters\n------\nx : float\n The x coordinate of the position to move to\ny : float\n The y coordinate of the position to move to\nz : float\n The z coordinate of the position to move to\nalpha : float, optional\n The alpha coordinate (rotation in radians about the x axis) of the position to move to.\nbeta : float, optional\n The beta coordinate (rotation in radians about the y axis) of the position to move to.\ngamma : float, optional\n The gamma coordinate (rotation in radians about the z axis) of the position to move to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c53fa42130 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address: TextBlob\n The IP address of the robot arm.\n\nParameters\n------\nx : float\n The x coordinate of the position to move to\ny : float\n The y coordinate of the position to move to\nz : float\n The z coordinate of the position to move to\nalpha : float, optional\n The alpha coordinate (rotation in radians about the x axis) of the position to move to.\nbeta : float, optional\n The beta coordinate (rotation in radians about the y axis) of the position to move to.\ngamma : float, optional\n The gamma coordinate (rotation in radians about the z axis) of the position to move to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..9a31682200 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address\n The IP address of the robot arm.\n\nParameters\n------\nx : float\n The x coordinate of the position to move to\ny : float\n The y coordinate of the position to move to\nz : float\n The z coordinate of the position to move to\nalpha : float, optional\n The alpha coordinate (rotation in radians about the x axis) of the position to move to.\nbeta : float, optional\n The beta coordinate (rotation in radians about the y axis) of the position to move to.\ngamma : float, optional\n The gamma coordinate (rotation in radians about the z axis) of the position to move to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..93e0d2516b --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nip_address: TextBlob\n The IP address of the robot arm.\n\nParameters\n------\nv : float\n The velocity to be set.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "ip_address", + "description": "The IP address of the robot arm." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/a1-[autogen]/docstring.json b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..036512a681 --- /dev/null +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/a1-[autogen]/docstring.json @@ -0,0 +1,5 @@ +{ + "description": "Inputs\n ------\n ip_address\n The IP address of the robot arm.\n\n Parameters\n ------\n v : float\n The angular velocity to be set for each joint.\n\nReturns\n -------\n ip_address\n The IP address of the robot arm.", + "parameters": [], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..33914e6d29 --- /dev/null +++ b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "data_container_id", + "type": "str", + "description": "The data container id of the data to be downloaded from Flojoy Cloud." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "The downloaded DataContainer will be returned as it is." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..56e1716f3f --- /dev/null +++ b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "measurement_id", + "type": "str", + "description": "The measurement id of the data to be uploaded to Flojoy Cloud." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "The input DataContainer will be returned as it is." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1d9deba22e --- /dev/null +++ b/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "referred_node", + "type": "str", + "description": "The ID of the node to retrieve the result from." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1b9e428408 --- /dev/null +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "From here, in conjunction with a loop, we iterate over all the files found, and return each one by file path as a TextBlob.\n\nThe TextBlob can be recognized as an optional input to the LOCAL_FILE node, which can then load the file at that path and return the appropriate datatype.", + "parameters": [ + { + "name": "current_iteration", + "type": "Scalar", + "description": "This is the input from the LOOP_INDEX node that determines\nwhether we need to initialize this routine or not." + }, + { + "name": "default_params", + "type": "DefaultParams", + "description": "This provides the node_id so that we can identify which\nobject in SmallMemory to pull (for example, unique identification\nof this node if there are multiple BATCH_PROCESSOR nodes)." + }, + { + "name": "directory_path", + "type": "str", + "description": "The directory in which we should match the pattern to find the files." + }, + { + "name": "pattern", + "type": "str", + "description": "The glob pattern to match.\nIf not provided, all files in the directory are returned.\nThe current implementation supports recursion and double wildcard matching." + }, + { + "name": "refresh", + "type": "bool", + "description": "A switching parameter that refreshes the cache of files. If a separate\nprogramme is expected to continuously write new files of interest to the\ndirectory, this flag will enable the update of the new files for processing." + } + ], + "returns": [ + { + "name": "fname", + "type": "TextBlob", + "description": "The file name on the current iteration." + }, + { + "name": "n_files", + "type": "Scalar", + "description": "The total number of files matched by the pattern in the given directory." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b990a03a5b --- /dev/null +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": null, + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "The path to the file to be loaded. This can be either an absolute path or\na path relative to the \"nodes\" directory." + }, + { + "name": "default", + "type": "Optional[TextBlob]", + "description": "If this input node is connected, the file name will be taken from\nthe output of the connected node.\nTo be used in conjunction with batch processing." + }, + { + "name": "file_type", + "type": "str", + "description": "Type of file to load, default = image.\nIf both 'file_path' and 'default' are not specified when 'file_type=\"Image\"',\na default image will be loaded.\nIf the file path is not specified and the default input is not connected,\na ValueError is raised." + } + ], + "returns": [ + { + "name": null, + "type": "Image | DataFrame", + "description": "Image for file_type 'image'.\nGrayscale from file_type 'Grayscale'.\nDataFrame for file_type 'json', 'csv'." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..81f7d029c6 --- /dev/null +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Note that if multiple 'tabs' of data are used, the number of rows must match in order to stack the arrays.", + "parameters": [ + { + "name": "file_path", + "type": "str", + "description": "path to the file to be loaded" + } + ], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "DataFrame loaded from the .mat file" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/a1-[autogen]/docstring.json b/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ae8eb39212 --- /dev/null +++ b/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Note: If both the file_url and default are not specified when file_type=\"Image\", a default image will be loaded.\n\nFor now, REMOTE_FILE only supports HTTP file URLs, in particular GCP URL (starting with gcp://). S3 URL (starting with s3://) and other bucket-like URLs are not supported.\n\nIf the file url is not specified and the default input is not connected, or if the file url is not a valid URL, a ValueError is raised.", + "parameters": [ + { + "name": "file_url", + "type": "str", + "description": "URL of the file to be loaded." + }, + { + "name": "default", + "type": "Optional[TextBlob]", + "description": "If this input node is connected, the file URL will be taken from\nthe output of the connected node.\nTo be used in conjunction with batch processing." + }, + { + "name": "file_type", + "type": "str", + "description": "Type of file to load, default = image." + } + ], + "returns": [ + { + "name": null, + "type": "Image|DataFrame", + "description": "Image for file_type 'image'.\nDataFrame for file_type 'json', 'csv', 'excel', 'xml'." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..696960a642 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "We are planning to add support for more DataContainer types in the future.\n\nIt then enqueues nodes connected with a \"true\" or \"false\" output based on the comparison result.", + "parameters": [ + { + "name": "operator_type", + "type": "select", + "description": "Specifies the type of comparison to be performed between the two inputs. The default value is \">=\"." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/LOOPS/APPEND/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/LOOPS/APPEND/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a82d30b1b9 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/LOOPS/APPEND/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "The large array must be passed to the bottom \"array\" connection.\n\nFor ordered pair, the single point must have a shape of 1 (or (1,)).\n\nInputs\n------\nprimary_dp : OrderedPair|Vector|Scalar|Matrix|DataFrame\n Input that ends up \"on top\" of the resulting DataContainer.\nsecondary_dp : OrderedPair|Vector|Scalar|Matrix|DataFrame\n Input that ends up \"on the bottom\" of the resulting DataContainer.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair, Matrix, DataFrame, Vector", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/LOOPS/LOOP/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/LOOPS/LOOP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5c497c2b51 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/LOOPS/LOOP/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [ + { + "name": "num_loops", + "type": "int", + "description": "number of times to iterate through body nodes, default is \"-1\" meaning infinity." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cdb45264e3 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": "It should be used in conjunction with conditionals to determine when to break the loop.\n\nIt is needed to be able to generate 'while loops' in Flojoy (combined with an 'infinite loop').", + "parameters": [ + { + "name": "referred_node", + "type": "NodeReference", + "description": "This is the specific instance of a LOOP node that you want to break.\nIt is required to differentiate between multiple LOOPs if they exist\nin the same application." + }, + { + "name": "default", + "type": "DataContainer", + "description": "This node simply requires an input (most likely from\nthe return of a CONDITIONAL node) so that it is executed." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..fb9c04d6d9 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "A loop index in Flojoy starts at 1 and increases by 1 for each loop.", + "parameters": [ + { + "name": "loop_node", + "type": "str", + "description": "The LOOP node to track the loop index from." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The loop index in Scalar form." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/TIMERS/TIMER/a1-[autogen]/docstring.json b/docs/nodes/LOGIC_GATES/TIMERS/TIMER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..80612c1376 --- /dev/null +++ b/docs/nodes/LOGIC_GATES/TIMERS/TIMER/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [ + { + "name": "sleep_time", + "type": "float", + "description": "number of seconds to sleep" + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/CHOLESKY/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/CHOLESKY/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..10b6022e55 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/CHOLESKY/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n Cholesky decomposition.\n\n Return the Cholesky decomposition, \"L * L.H\", of the square matrix \"a\", where \"L\" is lower-triangular and .H is the conjugate transpose operator (which is the ordinary transpose if \"a\" is real-valued).\n\n \"a\" must be Hermitian (symmetric if real-valued) and positive-definite. No checking is performed to verify whether \"a\" is Hermitian or not.\n\n In addition, only the lower-triangular and diagonal elements of \"a\" are used. Only \"L\" is actually returned.", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "Hermitian (symmetric if all elements are real), positive-definite input matrix." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/DET/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/DET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c22047beb9 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/DET/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the determinant of an array.", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "Input array to compute determinants." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/EIG/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/EIG/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7b8703471e --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/EIG/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the eigenvalues and right eigenvectors of a square array.", + "parameters": [ + { + "name": "select_return", + "type": "'w', 'v'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "(..., M, M) array", + "description": "Matrices for which the eigenvalues and right eigenvectors will be computed." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/EIGH/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/EIGH/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..00fd493a38 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/EIGH/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "The description of that function is as follows:\n\n Return the eigenvalues and eigenvectors of a complex Hermitian (conjugate symmetric) or a real symmetric matrix.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/EIGVALS/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/EIGVALS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..68c86e6005 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/EIGVALS/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the eigenvalues of a general matrix.\n\nMain difference between `eigvals` and `eig`: the eigenvectors are not returned.", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "A complex- or real-valued matrix whose eigenvalues will be computed." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/EIGVALSH/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/EIGVALSH/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d96617258b --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/EIGVALSH/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the eigenvalues of a complex Hermitian or real symmetric matrix.\n\nMain difference from eigh: the eigenvectors are not computed.", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "A complex- or real-valued matrix whose eigenvalues are to be computed." + }, + { + "name": "UPLO", + "type": "{'L', 'U'}", + "description": "Specifies whether the calculation is done with the lower triangular\npart of 'a' ('L', default) or the upper triangular part ('U').\nIrrespective of this value, only the real parts of the diagonal will\nbe considered in the computation to preserve the notion of a Hermitian matrix.\nIt therefore follows that the imaginary part of the diagonal will always\nbe treated as zero." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/INV/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/INV/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..665dbfba84 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/INV/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the (multiplicative) inverse of a matrix.\n\n Given a square matrix 'a', return the matrix 'ainv', satisfying \"dot(a, ainv) = dot(ainv, a) = eye(a.shape[0])\".", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "Matrix to be inverted." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/MATRIX_POWER/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/MATRIX_POWER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..0d603d16b2 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/MATRIX_POWER/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Raise a square matrix to the (integer) power 'n'.\n\n For positive integers 'n', the power is computed by repeated matrix squarings and matrix multiplications.\n\n If \"n == 0\", the identity matrix of the same shape as M is returned. If \"n < 0\", the inverse is computed and then raised to \"abs(n)\".\n\nNote: Stacks of object matrices are not currently supported.", + "parameters": [ + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "Matrix to be \"powered\"." + }, + { + "name": "n", + "type": "int", + "description": "The exponent can be any integer or long integer, positive, negative, or zero." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/PINV/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/PINV/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..49e1b138cd --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/PINV/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the (Moore-Penrose) pseudo-inverse of a matrix.\n\n Calculate the generalized inverse of a matrix using its singular-value decomposition (SVD) and including all **large** singular values.\n\n.. versionchanged:: 1.14\n Can now operate on stacks of matrices", + "parameters": [ + { + "name": "a", + "type": "(..., M, N) array_like", + "description": "Matrix or stack of matrices to be pseudo-inverted." + }, + { + "name": "rcond", + "type": "(...) array_like of float", + "description": "Cutoff for small singular values.\nSingular values less than or equal to \"rcond * largest_singular_value\" are set to zero.\nBroadcasts against the stack of matrices." + }, + { + "name": "hermitian", + "type": "bool", + "description": "If True, \"a\" is assumed to be Hermitian (symmetric if real-valued), enabling a more\nefficient method for finding singular values.\nDefaults to False." + }, + { + "name": ".. versionadded", + "type": ": 1.17.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/QR/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/QR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1454eeb5b8 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/QR/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the qr factorization of a matrix.\n\n Factor the matrix 'a' as *qr*, where 'q' is orthonormal and 'r' is upper-triangular.\n\nFor the 'mode' parameters, the options 'reduced', 'complete, and 'raw' are new in numpy 1.8 (see the notes for more information).\nThe default is 'reduced', and to maintain backward compatibility with earlier versions of numpy, both it and the old default 'full' can be omitted.\nNote that array h returned in 'raw' mode is transposed for calling Fortran.\nThe 'economic' mode is deprecated.\nThe modes 'full' and 'economic' may be passed using only the first letter for backwards compatibility,\nbut all others must be spelled out (see the Notes for further explanation).", + "parameters": [ + { + "name": "select_return", + "type": "'q', 'r', '(h, tau)'", + "description": "Select the desired opject to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array_like, shape (..., M, N)", + "description": "An array-like object with the dimensionality of at least 2." + }, + { + "name": "mode", + "type": "{'reduced', 'complete', 'r', 'raw'}", + "description": "If K = min(M, N), then:\n 'reduced' : returns q, r with dimensions (..., M, K), (..., K, N) (default)\n 'complete' : returns q, r with dimensions (..., M, M), (..., M, N)\n 'r' : returns r only with dimensions (..., K, N)\n 'raw' : returns h, tau with dimensions (..., N, M), (..., K,)" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/SLOGDET/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/SLOGDET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..da3816afb6 --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/SLOGDET/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the sign and (natural) logarithm of the determinant of an array.\n\n If an array has a very small or very large determinant, then a call to 'det' may overflow or underflow.\n\n This routine is more robust against such issues, because it computes the logarithm of the determinant rather than the determinant itself.", + "parameters": [ + { + "name": "select_return", + "type": "'sign', 'logdet'", + "description": "Select the desired object to return.\nSee the respective function documents for descriptors." + }, + { + "name": "a", + "type": "(..., M, M) array_like", + "description": "Input array, has to be a square 2-D array." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/SVD/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/SVD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8ffe708b0f --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/SVD/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "The description of that function is as follows:\n\n Singular Value Decomposition.\n\n When 'a' is a 2D array, and \"full_matrices=False\", then it is factorized as \"u @ np.diag(s) @ vh = (u * s) @ vh\",\n where 'u' and the Hermitian transpose of 'vh' are 2D arrays with orthonormal columns and 's' is a 1D array of 'a' singular values.\n\n When 'a' is higher-dimensional, SVD is applied in stacked mode as explained below.", + "parameters": [ + { + "name": "select_return", + "type": "'u', 's', 'vh'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "(..., M, N) array_like", + "description": "A real or complex array with \"a.ndim >= 2\"." + }, + { + "name": "full_matrices", + "type": "bool", + "description": "If True (default), 'u' and 'vh' have the shapes \"(..., M, M)\" and \"(..., N, N)\", respectively.\nOtherwise, the shapes are \"(..., M, K)\" and \"(..., K, N)\", respectively, where \"K = min(M, N)\"." + }, + { + "name": "compute_uv", + "type": "bool", + "description": "Whether or not to compute 'u' and 'vh' in addition to 's'.\nTrue by default." + }, + { + "name": "hermitian", + "type": "bool", + "description": "If True, 'a' is assumed to be Hermitian (symmetric if real-valued), enabling a more efficient method for finding singular values.\nDefaults to False." + }, + { + "name": ".. versionadded", + "type": ": 1.17.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/NUMPY/LINALG/TENSORINV/a1-[autogen]/docstring.json b/docs/nodes/NUMPY/LINALG/TENSORINV/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1f22257e2e --- /dev/null +++ b/docs/nodes/NUMPY/LINALG/TENSORINV/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the 'inverse' of an N-dimensional array.\n\n The result is an inverse for 'a' relative to the tensordot operation \"tensordot(a, b, ind)\",\n i.e. up to floating-point accuracy, \"tensordot(tensorinv(a), a, ind)\" is the \"identity\" tensor for the tensordot operation.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Tensor to 'invert'.\nIts shape must be 'square', i.e. \"prod(a.shape[:ind]) == prod(a.shape[ind:])\"." + }, + { + "name": "ind", + "type": "int", + "description": "Number of first indices that are involved in the inverse sum.\nMust be a positive integer, default is 2." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..0777749dba --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Calculate the relative maxima of 'data'.", + "parameters": [ + { + "name": "data", + "type": "ndarray", + "description": "Array in which to find the relative maxima." + }, + { + "name": "axis", + "type": "int", + "description": "Axis over which to select from 'data'. Default is 0." + }, + { + "name": "order", + "type": "int", + "description": "How many points on each side to use for the comparison\nto consider \"comparator(n, n+x)\" to be True." + }, + { + "name": "mode", + "type": "str", + "description": "How the edges of the vector are treated.\nAvailable options are 'wrap' (wrap around) or 'clip' (treat overflow\nas the same as the last (or first) element).\nDefault 'clip'. See numpy.take." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a65c72056d --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Calculate the relative minima of 'data'.", + "parameters": [ + { + "name": "data", + "type": "ndarray", + "description": "Array in which to find the relative minima." + }, + { + "name": "axis", + "type": "int", + "description": "Axis over which to select from 'data'. Default is 0." + }, + { + "name": "order", + "type": "int", + "description": "How many points on each side to use for the comparison\nto consider \"comparator(n, n+x)\" to be True." + }, + { + "name": "mode", + "type": "str", + "description": "How the edges of the vector are treated.\nAvailable options are 'wrap' (wrap around) or 'clip' (treat overflow\nas the same as the last (or first) element).\nDefault 'clip'. See numpy.take." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/BSPLINE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/BSPLINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e584d9668a --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/BSPLINE/a1-[autogen]/docstring.json @@ -0,0 +1,31 @@ +{ + "description": "The description of that function is as follows:\n\n B-spline basis function of order n.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "A knot vector." + }, + { + "name": "n", + "type": "int", + "description": "The order of the spline. Must be non-negative, i.e. n >= 0." + }, + { + "name": "Returns", + "type": null, + "description": null + }, + { + "name": "----------", + "type": null, + "description": null + }, + { + "name": "DataContainer", + "type": null, + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/CUBIC/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/CUBIC/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4084b75d2a --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/CUBIC/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n A cubic B-spline.\n This is a special case of 'bspline', and equivalent to \"bspline(x, 3)\".", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "a knot vector" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/DECIMATE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/DECIMATE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..73a0373e42 --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/DECIMATE/a1-[autogen]/docstring.json @@ -0,0 +1,47 @@ +{ + "description": "The description of that function is as follows:\n\n Downsample the signal after applying an anti-aliasing filter.\n\n By default, an order 8 Chebyshev type I filter is used. A 30 point FIR filter with Hamming window is used if `ftype` is 'fir'.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "The signal to be downsampled, as an N-dimensional array." + }, + { + "name": "q", + "type": "int", + "description": "The downsampling factor. When using IIR downsampling, it is recommended\nto call `decimate` multiple times for downsampling factors higher than 13." + }, + { + "name": "n", + "type": "int", + "description": "The order of the filter (1 less than the length for 'fir').\nDefaults to 8 for 'iir' and 20 times the downsampling factor for 'fir'." + }, + { + "name": "ftype", + "type": "str {'iir', 'fir'} or \"dlti\" instance", + "description": "If 'iir' or 'fir', specifies the type of lowpass filter.\nIf an instance of an \"dlti\" object, uses that object to filter before downsampling." + }, + { + "name": "axis", + "type": "int", + "description": "The axis along which to decimate." + }, + { + "name": "zero_phase", + "type": "bool", + "description": "Prevent phase shift by filtering with 'filtfilt' instead of 'lfilter'\nwhen using an IIR filter, and shifting the outputs back by the filter's\ngroup delay when using an FIR filter. The default value of 'True' is\nrecommended, since a phase shift is generally not desired." + }, + { + "name": ".. versionadded", + "type": ": 0.18.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/DETREND/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/DETREND/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7cc9c81509 --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/DETREND/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Remove a linear trend along an axis from data.", + "parameters": [ + { + "name": "data", + "type": "array_like", + "description": "The input data." + }, + { + "name": "axis", + "type": "int", + "description": "The axis along which to detrend the data.\nBy default this is the last axis (-1)." + }, + { + "name": "type", + "type": "{'linear', 'constant'}", + "description": "The type of detrending. If type == 'linear' (default),\nthe result of a linear least-squares fit to 'data' is subtracted from 'data'.\nIf type == 'constant', only the mean of 'data' is subtracted." + }, + { + "name": "bp", + "type": "array_like of ints", + "description": "A sequence of break points. If given, an individual linear fit is\nperformed for each part of 'data' between two break points.\nBreak points are specified as indices into 'data'.\nThis parameter only has an effect when type == 'linear'." + }, + { + "name": "overwrite_data", + "type": "bool", + "description": "If True, perform in place detrending and avoid a copy.\nDefault is False." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7e81f0565d --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Gaussian approximation to B-spline basis function of order n.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "A knot vector." + }, + { + "name": "n", + "type": "int", + "description": "The order of the spline. Must be non-negative, i.e. n >= 0." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/HILBERT/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/HILBERT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e34d1c51eb --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/HILBERT/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the analytic signal, using the Hilbert transform.\n\n The transformation is done along the last axis by default.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "Signal data. Must be real." + }, + { + "name": "N", + "type": "int", + "description": "Number of Fourier components. Default: x.shape[axis]." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which to do the transformation. Default: -1." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..af5cc74f2c --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the Kaiser parameter 'beta', given the attenuation 'a'.", + "parameters": [ + { + "name": "a", + "type": "float", + "description": "The desired attenuation in the stopband and maximum ripple in\nthe passband, in dB. This should be a *positive* number." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2fb728bf65 --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/a1-[autogen]/docstring.json @@ -0,0 +1,57 @@ +{ + "description": "The description of that function is as follows:\n\n Estimate power spectral density using a periodogram.", + "parameters": [ + { + "name": "select_return", + "type": "'f', 'Pxx'.", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Time series of measurement values." + }, + { + "name": "fs", + "type": "float", + "description": "Sampling frequency of the 'x' time series.\nDefaults to 1.0." + }, + { + "name": "window", + "type": "str or tuple or array_like", + "description": "Desired window to use.\nIf 'window' is a string or tuple, it is passed to 'get_window' to\ngenerate the window values, which are DFT-even by default.\nSee 'get_window' for a list of windows and required parameters.\nIf 'window' is array_like, it will be used directly as the window\nand its length must be nperseg.\nDefaults to 'boxcar'." + }, + { + "name": "nfft", + "type": "int", + "description": "Length of the FFT used.\nIf 'None', the length of 'x' will be used." + }, + { + "name": "detrend", + "type": "str or function or 'False'", + "description": "Specifies how to detrend each segment.\nIf 'detrend' is a string, it is passed as the 'type' argument\nto the 'detrend' function.\nIf it is a function, it takes a segment and returns a detrended segment.\nIf 'detrend' is 'False', no detrending is done.\nDefaults to 'constant'." + }, + { + "name": "return_onesided", + "type": "bool", + "description": "If 'True', return a one-sided spectrum for real data.\nIf 'False', return a two-sided spectrum.\nDefaults to 'True', but for complex data,\na two-sided spectrum is always returned." + }, + { + "name": "scaling", + "type": "{ 'density', 'spectrum' }", + "description": "Selects between computing the power spectral density ('density')\nwhere 'Pxx' has units of V**2/Hz and computing the power\nspectrum ('spectrum') where 'Pxx' has units of V**2, if 'x'\nis measured in V and 'fs' is measured in Hz.\nDefaults to 'density'." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which the periodogram is computed;\nthe default is over the last axis (i.e. axis=-1)." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/QUADRATIC/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/QUADRATIC/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..052db492e1 --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/QUADRATIC/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "The description of that function is as follows:\n\n A quadratic B-spline.\n\n This is a special case of 'bspline', and equivalent to 'bspline(x, 2)'.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "a knot vector" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..9c2234ae3f --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/a1-[autogen]/docstring.json @@ -0,0 +1,52 @@ +{ + "description": "The description of that function is as follows:\n\n Apply a Savitzky-Golay filter to an array.\n\n This is a 1-D filter. If 'x' has a dimension greater than 1, 'axis' determines the axis along which the filter is applied.", + "parameters": [ + { + "name": "x", + "type": "array_like", + "description": "The data to be filtered.\nIf 'x' is not a single or double precision floating point array,\nit will be converted to type numpy.float64 before filtering." + }, + { + "name": "window_length", + "type": "int", + "description": "The length of the filter window (i.e., the number of coefficients).\nIf 'mode' is 'interp', 'window_length' must be less than or equal to the size of 'x'." + }, + { + "name": "polyorder", + "type": "int", + "description": "The order of the polynomial used to fit the samples.\n'polyorder' must be less than 'window_length'." + }, + { + "name": "deriv", + "type": "int", + "description": "The order of the derivative to compute.\nThis must be a nonnegative integer.\nThe default is 0, which means to filter the data without differentiating." + }, + { + "name": "delta", + "type": "float", + "description": "The spacing of the samples to which the filter will be applied.\nThis is only used if deriv > 0. Default is 1.0." + }, + { + "name": "axis", + "type": "int", + "description": "The axis of the array 'x' along which the filter is to be applied.\nDefault is -1." + }, + { + "name": "mode", + "type": "str", + "description": "Must be 'mirror', 'constant', 'nearest', 'wrap' or 'interp'.\nThis determines the type of extension to use for the padded signal to\nwhich the filter is applied.\nWhen 'mode' is 'constant', the padding value is given by 'cval'.\nSee the Notes for more details on 'mirror', 'constant', 'wrap', and 'nearest'.\nWhen the 'interp' mode is selected (the default), no extension is used.\nInstead, a degree 'polyorder' polynomial is fit to the last\n'window_length' values of the edges, and this polynomial is\nused to evaluate the last 'window_length // 2' output values." + }, + { + "name": "cval", + "type": "scalar", + "description": "Value to fill past the edges of the input if 'mode' is 'constant'.\nDefault is 0.0." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/STFT/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/STFT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bccdb02d5d --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/STFT/a1-[autogen]/docstring.json @@ -0,0 +1,82 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the Short Time Fourier Transform (STFT).\n\n STFTs can be used as a way of quantifying the change of a nonstationary signal's frequency and phase content over time.", + "parameters": [ + { + "name": "select_return", + "type": "'f', 't', 'Zxx'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Time series of measurement values." + }, + { + "name": "fs", + "type": "float", + "description": "Sampling frequency of the 'x' time series.\nDefaults to 1.0." + }, + { + "name": "window", + "type": "str or tuple or array_like", + "description": "Desired window to use.\nIf 'window' is a string or tuple, it is passed to 'get_window'\nto generate the window values, which are DFT-even by default.\nSee 'get_window' for a list of windows and required parameters.\nIf 'window' is array_like it will be used directly as the window\nand its length must be nperseg.\nDefaults to a Hann window." + }, + { + "name": "nperseg", + "type": "int", + "description": "Length of each segment.\nDefaults to 256." + }, + { + "name": "noverlap", + "type": "int", + "description": "Number of points to overlap between segments.\nIf 'None', noverlap = nperseg // 2.\nDefaults to 'None'.\nWhen specified, the COLA constraint must be met (see Notes below)." + }, + { + "name": "nfft", + "type": "int", + "description": "Length of the FFT used, if a zero padded FFT is desired.\nIf 'None', the FFT length is 'nperseg'.\nDefaults to 'None'." + }, + { + "name": "detrend", + "type": "str or function or 'False'", + "description": "Specifies how to detrend each segment.\nIf 'detrend' is a string, it is passed as the 'type' argument to the 'detrend' function.\nIf it is a function, it takes a segment and returns a detrended segment.\nIf 'detrend' is 'False', no detrending is done.\nDefaults to 'False'." + }, + { + "name": "return_onesided", + "type": "bool", + "description": "If 'True', return a one-sided spectrum for real data.\nIf 'False' return a two-sided spectrum.\nDefaults to 'True', but for complex data, a two-sided spectrum is always returned." + }, + { + "name": "boundary", + "type": "str or None", + "description": "Specifies whether the input signal is extended at both ends, and\nhow to generate the new values, in order to center the first\nwindowed segment on the first input point.\nThis has the benefit of enabling reconstruction of the first input point\nwhen the employed window function starts at zero.\nValid options are ['even', 'odd', 'constant', 'zeros', None].\nDefaults to 'zeros', for zero padding extension.\nI.e. [1, 2, 3, 4] is extended to [0, 1, 2, 3, 4, 0] for nperseg=3." + }, + { + "name": "padded", + "type": "bool", + "description": "Specifies whether the input signal is zero-padded at the end to\nmake the signal fit exactly into an integer number of window\nsegments, so that all of the signal is included in the output.\nDefaults to 'True'.\nPadding occurs after boundary extension, if 'boundary' is not 'None',\nand 'padded' is 'True', as is the default." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which the STFT is computed.\nThe default is over the last axis (i.e. axis=-1)." + }, + { + "name": "scaling", + "type": "{'spectrum', 'psd'}", + "description": "The default 'spectrum' scaling allows each frequency line of 'Zxx' to\nbe interpreted as a magnitude spectrum.\nThe 'psd' option scales each line to a power spectral density.\nIt allows to calculate the signal's energy by numerically integrating over abs(Zxx)**2." + }, + { + "name": ".. versionadded", + "type": ": 1.9.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/SIGNAL/WELCH/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/SIGNAL/WELCH/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7744fbea65 --- /dev/null +++ b/docs/nodes/SCIPY/SIGNAL/WELCH/a1-[autogen]/docstring.json @@ -0,0 +1,77 @@ +{ + "description": "The description of that function is as follows:\n\n Estimate power spectral density using Welch's method.\n\n Welch's method [1]_ computes an estimate of the power spectral density by dividing the data into overlapping segments,\n computing a modified periodogram for each segment, and averaging the periodograms.", + "parameters": [ + { + "name": "select_return", + "type": "'f', 'Pxx'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Time series of measurement values." + }, + { + "name": "fs", + "type": "float", + "description": "Sampling frequency of the 'x' time series.\nDefaults to 1.0." + }, + { + "name": "window", + "type": "str or tuple or array_like", + "description": "Desired window to use. If 'window' is a string or tuple, it is\npassed to 'get_window' to generate the window values, which are\nDFT-even by default.\nSee 'get_window' for a list of windows and required parameters.\nIf 'window' is array_like,it will be used directly as the window\nand its length must be nperseg.\nDefaults to a Hann window." + }, + { + "name": "nperseg", + "type": "int", + "description": "Length of each segment.\nDefaults to None, but if window is str or tuple, is set to 256,\nand if window is array_like, is set to the length of the window." + }, + { + "name": "noverlap", + "type": "int", + "description": "Number of points to overlap between segments.\nIf 'None', noverlap = nperseg // 2.\nDefaults to 'None'." + }, + { + "name": "nfft", + "type": "int", + "description": "Length of the FFT used, if a zero padded FFT is desired.\nIf 'None', the FFT length is 'nperseg'.\nDefaults to 'None'." + }, + { + "name": "detrend", + "type": "str or function or 'False'", + "description": "Specifies how to detrend each segment.\nIf 'detrend' is a string, it is passed as the 'type' argument to the 'detrend' function.\nIf it is a function, it takes a segment and returns a detrended segment.\nIf 'detrend' is 'False', no detrending is done.\nDefaults to 'constant'." + }, + { + "name": "return_onesided", + "type": "bool", + "description": "If 'True', returns a one-sided spectrum for real data.\nIf 'False', returns a two-sided spectrum.\nDefaults to 'True', but for complex data, a two-sided spectrum is always returned." + }, + { + "name": "scaling", + "type": "{ 'density', 'spectrum' }", + "description": "Selects between computing the power spectral density ('density')\nwhere 'Pxx' has units of V**2/Hz and computing the power\nspectrum ('spectrum') where 'Pxx' has units of V**2, if 'x'\nis measured in V and 'fs' is measured in Hz.\nDefaults to 'density'." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which the periodogram is computed.\nThe default is over the last axis (i.e. axis=-1)." + }, + { + "name": "average", + "type": "{ 'mean', 'median' }", + "description": "Method to use when averaging periodograms.\nDefaults to 'mean'." + }, + { + "name": ".. versionadded", + "type": ": 1.2.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/ANDERSON/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/ANDERSON/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..56d1161a02 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/ANDERSON/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Anderson-Darling test for data coming from a particular distribution.\n\n The Anderson-Darling test tests the null hypothesis that a sample is drawn from a population that follows a particular distribution.\n For the Anderson-Darling test, the critical values depend on which distribution is being tested against.\n This function works for normal, exponential, logistic, or Gumbel (Extreme Value Type I) distributions.", + "parameters": [ + { + "name": "select_return", + "type": "This function has returns multiple objects ['statistic', 'critical_values', 'significance_level'].", + "description": "Select the desired one to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Array of sample data." + }, + { + "name": "dist", + "type": "{'norm', 'expon', 'logistic', 'gumbel', 'gumbel_l', 'gumbel_r', 'extreme1'}", + "description": "The type of distribution to test against.\nThe default is 'norm'.\nThe names 'extreme1', 'gumbel_l' and 'gumbel' are synonyms for the same distribution." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/BAYES_MVS/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/BAYES_MVS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..110af44c97 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/BAYES_MVS/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Bayesian confidence intervals for the mean, var, and std.", + "parameters": [ + { + "name": "data", + "type": "array_like", + "description": "Input data, if multi-dimensional it is flattened to 1-D by 'bayes_mvs'.\nRequires 2 or more data points." + }, + { + "name": "alpha", + "type": "float", + "description": "Probability that the returned confidence interval contains the true parameter." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/BINOM_TEST/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/BINOM_TEST/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..32a3297d04 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/BINOM_TEST/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Perform a test that the probability of success is p.\n\nNote: 'binom_test' is deprecated; it is recommended that 'binomtest' be used instead.\n\n This is an exact, two-sided test of the null hypothesis that the probability of success in a Bernoulli experiment is 'p'.", + "parameters": [ + { + "name": "x", + "type": "int or array_like", + "description": "The number of successes, or if x has length 2, it is the\nnumber of successes and the number of failures." + }, + { + "name": "n", + "type": "int", + "description": "The number of trials. This is ignored if x gives both the\nnumber of successes and failures." + }, + { + "name": "p", + "type": "float", + "description": "The hypothesized probability of success. 0 <= p <= 1.\nThe default value is p = 0.5." + }, + { + "name": "alternative", + "type": "{'two-sided', 'greater', 'less'}", + "description": "Indicates the alternative hypothesis.\nThe default value is 'two-sided'." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/DESCRIBE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/DESCRIBE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..68ebb89e4e --- /dev/null +++ b/docs/nodes/SCIPY/STATS/DESCRIBE/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "The description of that function is as follows:\n\n Compute several descriptive statistics of the passed array.", + "parameters": [ + { + "name": "select_return", + "type": "This function has returns multiple objects ['nobs', 'mean', 'variance', 'skewness', 'kurtosis'].", + "description": "Select the desired one to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array_like", + "description": "Input data." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which statistics are calculated. Default is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "ddof", + "type": "int", + "description": "Delta degrees of freedom (only for variance). Default is 1." + }, + { + "name": "bias", + "type": "bool", + "description": "If False, then the skewness and kurtosis calculations are corrected for statistical bias." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate': returns nan\n'raise': throws an error\n'omit': performs the calculations ignoring nan values" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/GSTD/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/GSTD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..88a88fb35f --- /dev/null +++ b/docs/nodes/SCIPY/STATS/GSTD/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Calculate the geometric standard deviation of an array.\n\n The geometric standard deviation describes the spread of a set of numbers where the geometric mean is preferred.\n It is a multiplicative factor, and so a dimensionless quantity.\n\n It is defined as the exponent of the standard deviation of log(a).\n\n Mathematically the population geometric standard deviation can be evaluated as::\n\n gstd = exp(std(log(a)))\n\n.. versionadded:: 1.3.0", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "An array like object containing the sample data." + }, + { + "name": "axis", + "type": "int, tuple or None", + "description": "Axis along which to operate. Default is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "ddof", + "type": "int", + "description": "Degree of freedom correction in the calculation of the geometric standard deviation.\nDefault is 1." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/GZSCORE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/GZSCORE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5d4ecbdc9f --- /dev/null +++ b/docs/nodes/SCIPY/STATS/GZSCORE/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the geometric standard score.\n\n Compute the geometric z score of each strictly positive value in the sample, relative to the geometric mean and standard deviation.\n\n Mathematically the geometric z score can be evaluated as::\n\n gzscore = log(a/gmu) / log(gsigma)\n\n where ``gmu`` (resp. ``gsigma``) is the geometric mean (resp. standard\n deviation).", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Sample data." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to operate.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "ddof", + "type": "int", + "description": "Degrees of freedom correction in the calculation of the standard deviation.\nDefault is 0." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan. 'propagate' returns nan,\n'raise' throws an error, 'omit' performs the calculations ignoring nan values.\nDefault is 'propagate'.\nNote that when the value is 'omit', nans in the input also propagate to the output,\nbut they do not affect the geometric z scores computed for the non-nan values." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/JARQUE_BERA/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/JARQUE_BERA/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a9ee891d65 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/JARQUE_BERA/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Perform the Jarque-Bera goodness of fit test on sample data.\n\n The Jarque-Bera test tests whether the sample data has the skewness and kurtosis matching a normal distribution.\n\n Note that this test only works for a large enough number of data samples (>2000) as the test statistic asymptotically has a Chi-squared distribution with 2 degrees of freedom.", + "parameters": [ + { + "name": "select_return", + "type": "'jb_value', 'p'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Observations of a random variable." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/KURTOSIS/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/KURTOSIS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..25eef49e2d --- /dev/null +++ b/docs/nodes/SCIPY/STATS/KURTOSIS/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the kurtosis (Fisher or Pearson) of a dataset.\n\n Kurtosis is the fourth central moment divided by the square of the variance.\n If Fisher's definition is used, then 3.0 is subtracted from the result to give 0.0 for a normal distribution.\n\n If bias is False then the kurtosis is calculated using k statistics to eliminate bias coming from biased moment estimators\n\n Use `kurtosistest` to see if result is close enough to normal.", + "parameters": [ + { + "name": "a", + "type": "array", + "description": "Data for which the kurtosis is calculated." + }, + { + "name": "axis", + "type": "int or None, default: 0", + "description": "If an int, the axis of the input along which to compute the statistic.\nThe statistic of each axis-slice (e.g. row) of the input will appear in a\ncorresponding element of the output.\nIf None, the input will be raveled before computing the statistic." + }, + { + "name": "fisher", + "type": "bool", + "description": "If True, Fisher's definition is used (normal ==> 0.0).\nIf False, Pearson's definition is used (normal ==> 3.0)." + }, + { + "name": "bias", + "type": "bool", + "description": "If False, then the calculations are corrected for statistical bias." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'omit', 'raise'}", + "description": "Defines how to handle input NaNs.\n- propagate : if a NaN is present in the axis slice (e.g. row) along\nwhich the statistic is computed, the corresponding entry of the output will be NaN.\n- omit : NaNs will be omitted when performing the calculation.\nIf insufficient data remains in the axis slice along which the\nstatistic is computed, the corresponding entry of the output will be NaN.\n- raise : if a NaN is present, a ValueError will be raised." + }, + { + "name": "keepdims", + "type": "bool, default: False", + "description": "If this is set to True, the axes which are reduced are left\nin the result as dimensions with size one. With this option,\nthe result will broadcast correctly against the input array." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/KURTOSISTEST/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/KURTOSISTEST/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..eeb1fe3a60 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/KURTOSISTEST/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "The description of that function is as follows:\n\n Test whether a dataset has normal kurtosis.\n\n This function tests the null hypothesis that the kurtosis of the population from which the sample was drawn is that of the normal distribution.", + "parameters": [ + { + "name": "select_return", + "type": "This function has returns multiple objects ['statistic', 'pvalue'].", + "description": "Select the desired one to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array", + "description": "Array of the sample data." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to compute test. Default is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : throws an error\n'omit' : performs the calculations ignoring nan values" + }, + { + "name": "alternative", + "type": "{'two-sided', 'less', 'greater'}", + "description": "Defines the alternative hypothesis.\nThe following options are available (default is 'two-sided'):\n'two-sided' : the kurtosis of the distribution underlying the sample is different from that of the normal distribution\n'less' : the kurtosis of the distribution underlying the sample is less than that of the normal distribution\n'greater' : the kurtosis of the distribution underlying the sample is greater than that of the normal distribution" + }, + { + "name": ".. versionadded", + "type": ": 1.7.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/MOMENT/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/MOMENT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a1361b7ab8 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/MOMENT/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Calculate the nth moment about the mean for a sample.\n\n A moment is a specific quantitative measure of the shape of a set of points.\n It is often used to calculate coefficients of skewness and kurtosis due to its close relationship with them.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Input array." + }, + { + "name": "moment", + "type": "int or array_like of ints", + "description": "Order of central moment that is returned.\nDefault is 1." + }, + { + "name": "axis", + "type": "int or None, default: 0", + "description": "If an int, the axis of the input along which to compute the statistic.\nThe statistic of each axis-slice (e.g. row) of the input will appear in a\ncorresponding element of the output.\nIf None, the input will be raveled before computing the statistic." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'omit', 'raise'}", + "description": "Defines how to handle input NaNs.\n- propagate : if a NaN is present in the axis slice (e.g. row) along\nwhich the statistic is computed, the corresponding entry of the output will be NaN.\n- omit : NaNs will be omitted when performing the calculation.\nIf insufficient data remains in the axis slice along which the\nstatistic is computed, the corresponding entry of the output will be NaN.\n- raise : if a NaN is present, a ValueError will be raised." + }, + { + "name": "keepdims", + "type": "bool, default: False", + "description": "If this is set to True, the axes which are reduced are left\nin the result as dimensions with size one. With this option,\nthe result will broadcast correctly against the input array." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/MVSDIST/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/MVSDIST/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..fb90f3c593 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/MVSDIST/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n 'Frozen' distributions for mean, variance, and standard deviation of data.", + "parameters": [ + { + "name": "select_return", + "type": "'mdist', 'vdist', 'sdist'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "data", + "type": "array_like", + "description": "Input array. Converted to 1-D using ravel.\nRequires 2 or more data-points." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/NORMALTEST/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/NORMALTEST/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..23c7d871c0 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/NORMALTEST/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Test whether a sample differs from a normal distribution.\n\n This function tests the null hypothesis that a sample comes from a normal distribution.\n It is based on D'Agostino and Pearson's [1]_, [2]_ test that combines skewness and kurtosis to produce an omnibus test of normality.", + "parameters": [ + { + "name": "select_return", + "type": "'statistic', 'pvalue'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array_like", + "description": "The array containing the sample to be tested." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to compute test.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : raises an error\n'omit' : performs the calculations ignoring nan values" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/SEM/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/SEM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4d58aee0e0 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/SEM/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the standard error of the mean.\n\n Calculate the standard error of the mean (or standard error of measurement) of the values in the input array.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "An array containing the values for which the standard error is returned." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to operate.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "ddof", + "type": "int", + "description": "Delta degrees-of-freedom. How many degrees of freedom to adjust\nfor bias in limited samples relative to the population estimate of variance.\nDefaults to 1." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : raises an error\n'omit' : performs the calculations ignoring nan values" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/SHAPIRO/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/SHAPIRO/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f79939529c --- /dev/null +++ b/docs/nodes/SCIPY/STATS/SHAPIRO/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Perform the Shapiro-Wilk test for normality.\n\n The Shapiro-Wilk test tests the null hypothesis that the data was drawn from a normal distribution.", + "parameters": [ + { + "name": "select_return", + "type": "'statistic', 'p-value'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "x", + "type": "array_like", + "description": "Array of sample data." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/SIGMACLIP/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/SIGMACLIP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e6621333a2 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/SIGMACLIP/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Perform iterative sigma-clipping of array elements.\n\n Starting from the full sample, all elements outside the critical range are removed,\n i.e. all elements of the input array 'c' that satisfy either of the following conditions::\n\n c < mean(c) - std(c)*low\n c > mean(c) + std(c)*high\n\n The iteration continues with the updated sample until no elements are outside the (updated) range.", + "parameters": [ + { + "name": "select_return", + "type": "This function has returns multiple objects ['clipped', 'lower', 'upper'].", + "description": "Select the desired one to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array_like", + "description": "Data array, will be raveled if not 1-D." + }, + { + "name": "low", + "type": "float", + "description": "Lower bound factor of sigma clipping. Default is 4." + }, + { + "name": "high", + "type": "float", + "description": "Upper bound factor of sigma clipping. Default is 4." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/SKEW/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/SKEW/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e0fbf12276 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/SKEW/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the sample skewness of a dataset.\n\n For normally distributed data, the skewness should be about zero. \n For unimodal continuous distributions, a skewness value greater than zero means that there is more weight in the right tail of the distribution. The function 'skewtest' can be used to determine if the skewness value is close enough to zero, statistically speaking.", + "parameters": [ + { + "name": "a", + "type": "ndarray", + "description": "Input array." + }, + { + "name": "axis", + "type": "int ", + "description": "Default = 0.\nIf an int, the axis of the input along which to compute the statistic.\nThe statistic of each axis-slice (e.g. row) of the input will appear in a\ncorresponding element of the output.\nIf None, the input will be raveled before computing the statistic." + }, + { + "name": "bias", + "type": "bool", + "description": "If False, then the calculations are corrected for statistical bias." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'omit', 'raise'}", + "description": "Defines how to handle input NaNs.\n- propagate : if a NaN is present in the axis slice (e.g. row) along\nwhich the statistic is computed, the corresponding entry of the output\nwill be NaN.\n- omit : NaNs will be omitted when performing the calculation.\nIf insufficient data remains in the axis slice along which the\nstatistic is computed, the corresponding entry of the output will be NaN.\n- raise : if a NaN is present, a ValueError will be raised." + }, + { + "name": "keepdims", + "type": "bool, default: False", + "description": "If this is set to True, the axes which are reduced are left\nin the result as dimensions with size one. With this option,\nthe result will broadcast correctly against the input array." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/SKEWTEST/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/SKEWTEST/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f2890664fb --- /dev/null +++ b/docs/nodes/SCIPY/STATS/SKEWTEST/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "The description of that function is as follows:\n\n Test whether the skewness is different from the normal distribution.\n\n This function tests the null hypothesis that the skewness of the population that the sample was drawn from is the same as that of a corresponding normal distribution.", + "parameters": [ + { + "name": "select_return", + "type": "'statistic', 'pvalue'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array", + "description": "The data to be tested." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which statistics are calculated.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : throws an error\n'omit' : performs the calculations ignoring nan values" + }, + { + "name": "alternative", + "type": "{'two-sided', 'less', 'greater'}", + "description": "Defines the alternative hypothesis.\nDefault is 'two-sided'.\nThe following options are available:\n'two-sided' : the skewness of the distribution underlying the sample\nis different from that of the normal distribution (i.e. 0)\n'less' : the skewness of the distribution underlying the sample\nis less than that of the normal distribution\n'greater' : the skewness of the distribution underlying the sample\nis greater than that of the normal distribution" + }, + { + "name": ".. versionadded", + "type": ": 1.7.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TMAX/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TMAX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d7281aec8e --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TMAX/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the trimmed maximum.\n\n This function computes the maximum value of an array along a given axis, while ignoring values larger than a specified upper limit.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Array of values." + }, + { + "name": "upperlimit", + "type": "None or float", + "description": "Values in the input array greater than the given limit will be ignored.\nWhen upperlimit is None, then all values are used.\nThe default value is None." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to operate.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "inclusive", + "type": "{True, False}", + "description": "This flag determines whether values exactly equal to the upper limit are included.\nThe default value is True." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : raises an error\n'omit' : performs the calculations ignoring nan values" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TMIN/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TMIN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cb160e8a24 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TMIN/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the trimmed minimum.\n\n This function finds the miminum value of an array 'a' along the specified axis, but only considering values greater than a specified lower limit.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Array of values." + }, + { + "name": "lowerlimit", + "type": "None or float", + "description": "Values in the input array less than the given limit will be ignored.\nWhen lowerlimit is None, then all values are used.\nThe default value is None." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to operate.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "inclusive", + "type": "{True, False}", + "description": "This flag determines whether values exactly equal to the lower limit are included.\nThe default value is True." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : raises an error\n'omit' : performs the calculations ignoring nan values" + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TRIM1/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TRIM1/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5ef768a355 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TRIM1/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Slice off a proportion from ONE end of the passed array distribution.\n\n If 'proportiontocut' = 0.1, slices off 'leftmost' or 'rightmost' 10% of scores.\n The lowest or highest values are trimmed (depending on the tail).\n Slice off less if proportion results in a non-integer slice index (i.e. conservatively slices off 'proportiontocut').", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Input array." + }, + { + "name": "proportiontocut", + "type": "float", + "description": "Fraction to cut off of 'left' or 'right' of distribution." + }, + { + "name": "tail", + "type": "{'left', 'right'}", + "description": "Defaults to 'right'." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to trim data.\nDefault is 0.\nIf None, compute over the whole array 'a'." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TRIMBOTH/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TRIMBOTH/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a3eb62364e --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TRIMBOTH/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Slice off a proportion of items from both ends of an array.\n\n Slice off the passed proportion of items from both ends of the passed array\n (i.e., with 'proportiontocut' = 0.1, slices leftmost 10% and rightmost 10% of scores).\n The trimmed values are the lowest and highest ones.\n Slice off less if proportion results in a non-integer slice index (i.e. conservatively slices off 'proportiontocut').", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Data to trim." + }, + { + "name": "proportiontocut", + "type": "float", + "description": "Proportion (in range 0-1) of total data set to trim of each end." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to trim data.\nDefault is 0.\nIf None, compute over the whole array 'a'." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TRIM_MEAN/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TRIM_MEAN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..40b5da8f9f --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TRIM_MEAN/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The description of that function is as follows:\n\n Return the mean of an array after trimming distribution from both tails.\n\n If `proportiontocut` = 0.1, slices off 'leftmost' and 'rightmost' 10% of scores.\n The input is sorted before slicing.\n Slices off less if proportion results in a non-integer slice index (i.e. conservatively slices off 'proportiontocut').", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Input array." + }, + { + "name": "proportiontocut", + "type": "float", + "description": "Fraction to cut off of both tails of the distribution." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which the trimmed means are computed.\nDefault is 0.\nIf None, compute over the whole array 'a'." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/TTEST_1SAMP/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/TTEST_1SAMP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..39153ce262 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/TTEST_1SAMP/a1-[autogen]/docstring.json @@ -0,0 +1,47 @@ +{ + "description": "The description of that function is as follows:\n\n Calculate the T-test for the mean of ONE group of scores.\n\n This is a test for the null hypothesis that the expected value (mean) of a sample of independent observations 'a' is equal to the given population mean, 'popmean'.", + "parameters": [ + { + "name": "select_return", + "type": "'statistic', 'pvalue'", + "description": "Select the desired object to return.\nSee the respective function docs for descriptors." + }, + { + "name": "a", + "type": "array_like", + "description": "Sample observation." + }, + { + "name": "popmean", + "type": "float or array_like", + "description": "Expected value in null hypothesis.\nIf array_like, then it must have the same shape as 'a' excluding the axis dimension." + }, + { + "name": "axis", + "type": "int or None", + "description": "Axis along which to compute test.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan.\nThe following options are available (default is 'propagate'):\n'propagate' : returns nan\n'raise' : raises an error\n'omit' : performs the calculations ignoring nan values" + }, + { + "name": "alternative", + "type": "{'two-sided', 'less', 'greater'}", + "description": "Defines the alternative hypothesis.\nThe following options are available (default is 'two-sided'):\n'two-sided' : the mean of the underlying distribution of the sample\nis different than the given population mean (`popmean`)\n'less' : the mean of the underlying distribution of the sample is\nless than the given population mean (`popmean`)\n'greater' : the mean of the underlying distribution of the sample is\ngreater than the given population mean (`popmean`)" + }, + { + "name": ".. versionadded", + "type": ": 1.6.0", + "description": null + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/VARIATION/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/VARIATION/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bd1388fcfd --- /dev/null +++ b/docs/nodes/SCIPY/STATS/VARIATION/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the coefficient of variation.\n\n The coefficient of variation is the standard deviation divided by the mean.\n\n This function is equivalent to:\n\n np.std(x, axis=axis, ddof=ddof) / np.mean(x)\n\n The default for 'ddof' is 0, but many definitions of the coefficient of variation use the square root of the unbiased sample variance for the sample standard deviation, which corresponds to 'ddof=1'.\n\n The function does not take the absolute value of the mean of the data, so the return value is negative if the mean is negative.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "Input array." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which to calculate the coefficient of variation.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains 'nan'.\nThe following options are available:\n'propagate' : return 'nan'\n'raise' : raise an exception\n'omit' : perform the calculation with 'nan' values omitted\nThe default is 'propagate'." + }, + { + "name": "ddof", + "type": "int", + "description": "Gives the \"Delta Degrees Of Freedom\" used when computing the standard deviation.\nThe divisor used in the calculation of the standard deviation is 'N - ddof',\nwhere 'N' is the number of elements.\n'ddof' must be less than 'N'; if it isn't, the result will be 'nan' or 'inf',\ndepending on 'N' and the values in the array.\nBy default, 'ddof' is zero for backwards compatibility,\nbut it is recommended to use 'ddof=1' to ensure that the sample\nstandard deviation is computed as the square root of the unbiased\nsample variance." + }, + { + "name": "keepdims", + "type": "bool", + "description": "If this is set to True, the axes which are reduced are left in the\nresult as dimensions with size one.\nWith this option, the result will broadcast correctly against the input array." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/YEOJOHNSON/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/YEOJOHNSON/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8c84a7adc5 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/YEOJOHNSON/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The description of that function is as follows:\n\n Return a dataset transformed by a Yeo-Johnson power transformation.", + "parameters": [ + { + "name": "x", + "type": "ndarray", + "description": "Input array.\nShould be 1-dimensional." + }, + { + "name": "lmbda", + "type": "float", + "description": "If 'lmbda' is 'None', find the lambda that maximizes the\nlog-likelihood function and return it as the second output argument.\nOtherwise the transformation is done for the given value." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/SCIPY/STATS/ZSCORE/a1-[autogen]/docstring.json b/docs/nodes/SCIPY/STATS/ZSCORE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..6b75b19845 --- /dev/null +++ b/docs/nodes/SCIPY/STATS/ZSCORE/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "The description of that function is as follows:\n\n Compute the z-score.\n\n Compute the z-score of each value in the sample, relative to the sample mean and standard deviation.", + "parameters": [ + { + "name": "a", + "type": "array_like", + "description": "An array like object containing the sample data." + }, + { + "name": "axis", + "type": "int", + "description": "Axis along which to operate.\nDefault is 0.\nIf None, compute over the whole array 'a'." + }, + { + "name": "ddof", + "type": "int", + "description": "Degrees of freedom correction in the calculation of the standard deviation.\nDefault is 0." + }, + { + "name": "nan_policy", + "type": "{'propagate', 'raise', 'omit'}", + "description": "Defines how to handle when input contains nan. 'propagate' returns nan,\n'raise' throws an error, 'omit' performs the calculations ignoring nan values.\nDefault is 'propagate'.\nNote that when the value is 'omit', nans in the input also propagate to the output,\nbut they do not affect the z-scores computed for the non-nan values." + } + ], + "returns": [ + { + "name": null, + "type": "DataContainer", + "description": "type 'ordered pair', 'scalar', or 'matrix'" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..0b6d9e4729 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Vector|Scalar\n The input to apply the absolute value to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: the x-axis of the input.\ny: the absolute value of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..87ed161bd2 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "When a constant is added to an array or matrix, each element in the array or matrix will be increased by the constant value.\n\nIf two arrays or matrices of different sizes are added, the output will be the size of the larger array or matrix with only the overlapping elements changed.\n\nInputs\n------\na : OrderedPair|Scalar|Vector\n The input a use to compute the sum of a and b.\nb : OrderedPair|Scalar|Vector\n The input b use to compute the sum of a and b.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair|Scalar|Vector", + "description": "OrderedPair if a is an OrderedPair.\nx: the x-axis of input a.\ny: the sum of input a and input b.\n\nScalar if a is a Scalar.\nc: the sum of input a and input b.\n\nVector if a is a Vector.\nv: the sum of input a and input b." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1b3082a021 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "When a constant is divided into an array or matrix, each element in the array or matrix will be divided by the constant value.\n\nInputs\n------\na : OrderedPair|Scalar|Vector\n The input that will be divide by b.\nb : OrderedPair|Scalar|Vector\n The input that will divide a.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair|Scalar|Vector", + "description": "OrderedPair if a is an OrderedPair.\nx: the x-axis of input a.\ny: the result of the division of input a by input b.\n\nScalar if a is a Scalar.\nc: the result of the division of input a by input b.\n\nVector if a is a Vector.\nv: the result of the division of input a by input b." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..41842f7001 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\na : OrderedPair|Scalar|Vector\n The input a use to compute the product of a and b.\nb : OrderedPair|Scalar|Vector\n The input b use to compute the product of a and b.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair|Scalar|Vector", + "description": "OrderedPair if a is an OrderedPair.\nx: the x-axis of input a.\ny: the result of the product of input a and input b.\n\nScalar if a is a Scalar.\nc: the result of the product of input a and input b.\n\nVector if a is a Vector.\nv: the result of the product of input a and input b." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..da66e862af --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\na : OrderedPair|Scalar|Vector\n The input a use in the subtraction of a by b.\nb : OrderedPair|Scalar|Vector\n The input b use in the subtraction of a by b.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair|Scalar|Vector", + "description": "OrderedPair if a is an OrderedPair.\nx: the x-axis of input a.\ny: the result of the subtraction of input a by input b.\n\nScalar if a is a Scalar.\nc: the result of the subtraction of input a by input b.\n\nVector if a is a Vector.\nv: the result of the subtraction of input a by input b." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..42956a4fec --- /dev/null +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "It then computes the derivative of the array, y, with respect to x.\n\nInputs\n------\ndefault : OrderedPair|Vector\n Input from which we get the x and y lists use in the derivative.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: the x-axis of the input.\ny: the result of the derivative." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..6d56ea2463 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "It then computes a double integral of the given function.\n\nExample of proper syntax for the function input:\n2*x*y\n\nExample of improper syntax for the function input:\n2xy", + "parameters": [ + { + "name": "function", + "type": "str", + "description": "The function that we are integrating." + }, + { + "name": "upper_bound_x", + "type": "float", + "description": "The upper bound for x." + }, + { + "name": "lower_bound_x", + "type": "float", + "description": "The lower bound for x." + }, + { + "name": "upper_bound_y", + "type": "float", + "description": "The upper bound for y." + }, + { + "name": "lower_bound_y", + "type": "float", + "description": "The lower bound for y." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The result of the double definite integral." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e65e6f5812 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The width and height represent the number of columns and rows, respectively, that the x, y, and z reshaped matrices will have.\nHere it is important to note that the length of x, y, and z is the same, and that the width times the height needs to be equal to the length of x, y, and z.\n\nIt computes the double integral approximation according to given dimensions of the matrices, and returns a matrix where each cell represents the volume up to the given point.\n\nInputs\n------\ndefault : OrderedTriple\n Input from which we use x, y, and z to compute the integral.", + "parameters": [ + { + "name": "width", + "type": "int", + "description": "Number of columns of the 3 matrices generated by reshaping the x, y, and z columns of the OrderedTriple." + }, + { + "name": "height", + "type": "int", + "description": "Number of rows of the 3 matrices generated by reshaping the x, y, and z columns of the OrderedTriple." + } + ], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "The matrix that contains the volume up to that point in each cell." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/examples/EX1/app.json b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/examples/EX1/app.json index f1e83f3672..177776b0da 100644 --- a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/examples/EX1/app.json +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/examples/EX1/app.json @@ -1,138 +1,6 @@ { "rfInstance": { "nodes": [ - { - "width": 208, - "height": 96, - "id": "R_DATASET-63e04d25-9599-41b6-ba5e-3df0c3245a75", - "type": "GENERATORS", - "data": { - "id": "R_DATASET-63e04d25-9599-41b6-ba5e-3df0c3245a75", - "label": "R DATASET", - "func": "R_DATASET", - "type": "GENERATORS", - "ctrls": { - "dataset_key": { - "type": "select", - "default": "iris", - "options": [ - "ability.cov", - "airmiles", - "AirPassengers", - "airquality", - "anscombe", - "attenu", - "attitude", - "austres", - "BJsales", - "BOD", - "cars", - "ChickWeight", - "chickwts", - "co2", - "crimtab", - "discoveries", - "DNase", - "esoph", - "euro", - "EuStockMarkets", - "faithful", - "Formaldehyde", - "freeny", - "HairEyeColor", - "Harman23", - "Harman74", - "Indometh", - "infert", - "InsectSprays", - "iris", - "iris3", - "islands", - "JohnsonJohnson", - "LakeHuron", - "LifeCycleSavings", - "Loblolly", - "longley", - "lynx", - "morley", - "mtcars", - "nhtemp", - "Nile", - "nottem", - "npk", - "occupationalStatus", - "Orange", - "OrchardSprays", - "PlantGrowth", - "precip", - "presidents", - "pressure", - "Puromycin", - "quakes", - "randu", - "rivers", - "rock", - "Seatbelts", - "sleep", - "stackloss", - "sunspot.month", - "sunspot.year", - "sunspots", - "swiss", - "Theoph", - "Titanic", - "ToothGrowth", - "treering", - "trees", - "UCBAdmissions", - "UKDriverDeaths", - "UKgas", - "USAccDeaths", - "USArrests", - "USJudgeRatings", - "USPersonalExpenditure", - "VADeaths", - "volcano", - "warpbreaks", - "women", - "WorldPhones", - "WWWusage" - ], - "desc": null, - "functionName": "R_DATASET", - "param": "dataset_key", - "value": "DNase" - } - }, - "initCtrls": {}, - "outputs": [ - { - "name": "default", - "id": "default", - "type": "DataFrame", - "desc": "A DataContainer object containing the retrieved pandas DataFrame." - } - ], - "pip_dependencies": [ - { - "name": "rdatasets", - "v": "0.1.0" - } - ], - "path": "PYTHON/nodes/GENERATORS/SAMPLE_DATASETS/R_DATASET/R_DATASET.py", - "selected": false - }, - "position": { - "x": -974.2422309907095, - "y": -820.0294878929864 - }, - "selected": false, - "positionAbsolute": { - "x": -974.2422309907095, - "y": -820.0294878929864 - }, - "dragging": true - }, { "width": 160, "height": 160, @@ -192,12 +60,12 @@ }, "position": { "x": -717.6599601242405, - "y": -860.1600465620575 + "y": -861.3087449170545 }, "selected": false, "positionAbsolute": { "x": -717.6599601242405, - "y": -860.1600465620575 + "y": -861.3087449170545 }, "dragging": true }, @@ -218,7 +86,7 @@ "desc": "Number of columns of the 3 matrices generated by reshaping the x, y, and z columns of the OrderedTriple.", "functionName": "DOUBLE_INDEFINITE_INTEGRAL", "param": "width", - "value": 16 + "value": 25 }, "height": { "type": "int", @@ -226,7 +94,7 @@ "desc": "Number of rows of the 3 matrices generated by reshaping the x, y, and z columns of the OrderedTriple.", "functionName": "DOUBLE_INDEFINITE_INTEGRAL", "param": "height", - "value": 11 + "value": 40 } }, "initCtrls": {}, @@ -251,12 +119,12 @@ "selected": false }, "position": { - "x": -433.28611846856074, + "x": -430.9887217585666, "y": -857.9246665999526 }, "selected": false, "positionAbsolute": { - "x": -433.28611846856074, + "x": -430.9887217585666, "y": -857.9246665999526 }, "dragging": true @@ -314,8 +182,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 384, + "height": 288, "id": "TEXT_VIEW-44511591-de2f-450e-aca7-d44452751448", "type": "VISUALIZERS", "data": { @@ -349,8 +217,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "SURFACE3D-01e54d50-c2a1-47cf-bb5f-e7dc68a39281", "type": "VISUALIZERS", "data": { @@ -378,28 +246,28 @@ } ], "path": "PYTHON/nodes/VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.py", - "selected": false + "selected": true }, "position": { - "x": 143.23035742089172, - "y": -849.1302089066567 + "x": 155.23035742089172, + "y": -858.1302089066567 }, - "selected": false, + "selected": true, "positionAbsolute": { - "x": 143.23035742089172, - "y": -849.1302089066567 + "x": 155.23035742089172, + "y": -858.1302089066567 }, "dragging": true }, { - "width": 225, - "height": 226, - "id": "MATRIX_VIEW-9602e385-cc42-40d8-9c19-c2fd3164951c", + "width": 380, + "height": 293, + "id": "TABLE-7148044d-863f-4882-bfc9-1c35b85a1742", "type": "VISUALIZERS", "data": { - "id": "MATRIX_VIEW-9602e385-cc42-40d8-9c19-c2fd3164951c", - "label": "MATRIX VIEW", - "func": "MATRIX_VIEW", + "id": "TABLE-7148044d-863f-4882-bfc9-1c35b85a1742", + "label": "TABLE", + "func": "TABLE", "type": "VISUALIZERS", "ctrls": {}, "initCtrls": {}, @@ -407,9 +275,9 @@ { "name": "default", "id": "default", - "type": "OrderedPair|Matrix", + "type": "OrderedTriple|OrderedPair|DataFrame|Vector", "multiple": false, - "desc": null + "desc": "the DataContainer to be visualized" } ], "outputs": [ @@ -417,63 +285,116 @@ "name": "default", "id": "default", "type": "Plotly", - "desc": "the DataContainer containing visualization of the input in matrix format" + "desc": "the DataContainer containing Plotly Table visualization" } ], - "path": "PYTHON/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.py", + "path": "PYTHON/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.py", "selected": false }, "position": { - "x": -132.2027860677881, - "y": -630.2566818451229 + "x": -545.787793504827, + "y": -631.9942674910868 }, "selected": false, "positionAbsolute": { - "x": -132.2027860677881, - "y": -630.2566818451229 + "x": -545.787793504827, + "y": -631.9942674910868 }, "dragging": true }, { - "width": 225, - "height": 226, - "id": "TABLE-7148044d-863f-4882-bfc9-1c35b85a1742", - "type": "VISUALIZERS", + "width": 208, + "height": 96, + "id": "MATRIX-7136a21d-9bd8-4fb5-8832-80c527d9036c", + "type": "GENERATORS", "data": { - "id": "TABLE-7148044d-863f-4882-bfc9-1c35b85a1742", - "label": "TABLE", - "func": "TABLE", - "type": "VISUALIZERS", + "id": "MATRIX-7136a21d-9bd8-4fb5-8832-80c527d9036c", + "label": "MATRIX", + "func": "MATRIX", + "type": "GENERATORS", + "ctrls": { + "row": { + "type": "int", + "default": 2, + "desc": "number of rows", + "overload": null, + "functionName": "MATRIX", + "param": "row", + "value": 1000 + }, + "column": { + "type": "int", + "default": 2, + "desc": "number of columns", + "overload": null, + "functionName": "MATRIX", + "param": "column", + "value": 3 + } + }, + "initCtrls": {}, + "outputs": [ + { + "name": "default", + "id": "default", + "type": "Matrix", + "desc": "randomly generated matrix" + } + ], + "path": "GENERATORS/SIMULATIONS/MATRIX/MATRIX.py", + "selected": false + }, + "position": { + "x": -1284.7040612581184, + "y": -830.3249451717165 + }, + "selected": false, + "positionAbsolute": { + "x": -1284.7040612581184, + "y": -830.3249451717165 + }, + "dragging": true + }, + { + "width": 160, + "height": 160, + "id": "MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9e", + "type": "TRANSFORMERS", + "data": { + "id": "MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9e", + "label": "MAT 2 DF", + "func": "MAT_2_DF", + "type": "TRANSFORMERS", "ctrls": {}, "initCtrls": {}, "inputs": [ { "name": "default", "id": "default", - "type": "OrderedTriple|OrderedPair|DataFrame|Vector", + "type": "Matrix", "multiple": false, - "desc": "the DataContainer to be visualized" + "desc": "The input matrix to which we apply the conversion to." } ], "outputs": [ { "name": "default", "id": "default", - "type": "Plotly", - "desc": "the DataContainer containing Plotly Table visualization" + "type": "DataFrame", + "desc": "The dataframe result from the conversion of the input." } ], - "path": "PYTHON/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.py", + "path": "TRANSFORMERS/TYPE_CASTING/MAT_2_DF/MAT_2_DF.py", "selected": false }, "position": { - "x": -545.787793504827, - "y": -631.9942674910868 + "x": -975.0041797428814, + "y": -860.8336298362282 }, "selected": false, "positionAbsolute": { - "x": -545.787793504827, - "y": -631.9942674910868 + "x": -975.0041797428814, + "y": -860.8336298362282 }, "dragging": true } @@ -486,13 +407,6 @@ "targetHandle": "_", "id": "reactflow__edge-DOUBLE_INDEFINITE_INTEGRAL-3f53f6cd-dea7-4216-a9ca-b1678e4e1659default-TEXT-7d06c267-4df4-46cb-955a-590364ffbe7f_" }, - { - "source": "R_DATASET-63e04d25-9599-41b6-ba5e-3df0c3245a75", - "sourceHandle": "default", - "target": "DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5a", - "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-63e04d25-9599-41b6-ba5e-3df0c3245a75default-DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5adefault" - }, { "source": "DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5a", "sourceHandle": "default", @@ -507,14 +421,6 @@ "targetHandle": "default", "id": "reactflow__edge-DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5adefault-TABLE-7148044d-863f-4882-bfc9-1c35b85a1742default" }, - { - "source": "DOUBLE_INDEFINITE_INTEGRAL-3f53f6cd-dea7-4216-a9ca-b1678e4e1659", - "sourceHandle": "default", - "target": "MATRIX_VIEW-9602e385-cc42-40d8-9c19-c2fd3164951c", - "targetHandle": "default", - "id": "reactflow__edge-DOUBLE_INDEFINITE_INTEGRAL-3f53f6cd-dea7-4216-a9ca-b1678e4e1659default-MATRIX_VIEW-9602e385-cc42-40d8-9c19-c2fd3164951cdefault", - "selected": false - }, { "source": "DOUBLE_INDEFINITE_INTEGRAL-3f53f6cd-dea7-4216-a9ca-b1678e4e1659", "sourceHandle": "default", @@ -528,6 +434,20 @@ "target": "TEXT_VIEW-44511591-de2f-450e-aca7-d44452751448", "targetHandle": "default", "id": "reactflow__edge-TEXT-7d06c267-4df4-46cb-955a-590364ffbe7fdefault-TEXT_VIEW-44511591-de2f-450e-aca7-d44452751448default" + }, + { + "source": "MATRIX-7136a21d-9bd8-4fb5-8832-80c527d9036c", + "sourceHandle": "default", + "target": "MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9e", + "targetHandle": "default", + "id": "reactflow__edge-MATRIX-7136a21d-9bd8-4fb5-8832-80c527d9036cdefault-MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9edefault" + }, + { + "source": "MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9e", + "sourceHandle": "default", + "target": "DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5a", + "targetHandle": "default", + "id": "reactflow__edge-MAT_2_DF-5188bea2-1358-429d-9027-37a7608d2e9edefault-DF_2_ORDERED_TRIPLE-9187e7e2-5b69-4f50-92c2-89e9ad32eb5adefault" } ], "viewport": { @@ -535,5 +455,6 @@ "y": 226.88940714410813, "zoom": 0.5 } - } + }, + "textNodes": [] } \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e668c57898 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Vector\n Input from which we get the two lists we use in the integration.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: the x-axis of the input.\ny: the result of the integral." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cb2be66a6e --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": null, + "parameters": [], + "returns": [ + { + "name": null, + "type": "Image", + "description": "The image with each channel given by the appropriate channel\non the respective inputs." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bbbc491f7f --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "While the notion of \"splitting an image into RGBA channels\" is inherently tied to coloured pictures, this function will attempt to make sense of multiple input types.\n\nShould the input be of type 'Image', then the function will return the RGBA channels.\n\nShould the input be of type 'Matrix', meaning ideally a 3D 'numpy' array of size (L, M, 3) or (L, M, 4), then the function will return each channel respectively.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "IMAGE_CHANNEL_OUTPUTS", + "description": "The images, each channel itself is rendered with alpha=1,\nexcept the alpha channel itself." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2478a26ba6 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "This is done through the Pillow image filter, FIND_EDGES.\n\nNote that the image is converted to greyscale during this processing.\n\nInputs\n------\ndefault : Image\n The input image to apply edge detection to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Image", + "description": "The image with detected edges in white." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a8c6807af4 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/a1-[autogen]/docstring.json @@ -0,0 +1,5 @@ +{ + "description": "The ability to find local peaks will not depend on the extrema being\n exponentially separated from the neighboring values, or some other restrictive constraint.\n\n We implement three algorithms to find the local max. The first algorithm uses a masked phase\n cross correlation technique [1], while the second uses the persistence birth/death algorithms [2, 3].\n The original implementations of these libraries were utilized for the detection of elastic\n scattering peaks in diffraction data, found in the 'scikit-ued' library of Python [4].\n\n Note that the algorithm assumes that the extrema are symmetrically distributed around\n a center point. All extrema are determined relative to the center position.\n Also, for closely spaced points, noisy data, or data that has a very high dynamic range, the\n algorithm fails. Therefore, this approach is suited only for images with\n high degrees of symmetry and reasonable contrast.\n\n Therefore, we also use the second prominence algorithm, where a single\n value is applied locally to determine the relative 'peakiness' of a given pixel,\n inspecting only the neighbors around that given pixel. While computationally\n more intense for images with a resolution of >4K, it produces extremely accurate\n results for the correct value of prominence in potentially low-contrast images.\n By definition, it is a local pixel algorithm, and therefore does not perform any blob detection,\n unlike the high-symmetry algorithm which creates high contrast in\n the image with laplacian filtering, and identifies regions of this high contrast image.\n\n Note, however, that the persistence algorithm tends to find more points than what are actually there.\n For images with high frequency components (i.e. quickly varying values among the third nearest neighbours),\n the algorithm will tend to identify each as a 'peak', even though the local maxima is elsewhere. This\n therefore assumes that the image has been properly preprocessed with another image processing node to\n provide a sufficient low-frequency image such that the prominence of each pixel is well defined.\n\n To combat this limitation, we present the most robust of the algorithms that should work on images\n of low or high contrast, low or high frequency components, and of low or high dynamic range. It is\n computationally more expensive, as it involves repeated convolutions of the image, but it is\n the most reliable of the methods for a general image.\n\n This routine is known as the Laplacian of Gaussian algorithm [5].\n The key to this algorithm is to apply a filter specially chosen such that regions around peaks have high\n levels of contrast (essentially binarize the image around its peak so that near the peak, the\n image is one, and zero otherwise). To achieve such a filter, the Laplacian of a Gaussian is used:\n\n .. math:: \nabla^2 L \\equiv L_{xx} + L_{yy}\n\n which yields the following filter (for a Gaussian of width sigma, centered at the origin):\n\n ..math :: LG = -\frac{1}{\\pi\\sigma^4}\big[1-\frac{x^2+y^2}{2\\sigma^2}\big]e^{-\frac{x^2+y^2}{2\\sigma^2}}\n\n The output of this filter will be a maximum where there is an edge from a peak, the maximum response\n of which is given for 1.41*'blob radius' around the peak.\n Applying this filter repeatedly with varying degrees of sigma, will continue to refine the edges around\n the peak until the image is essentially binarized around the peaks. Due to the repeated convolutions,\n this algorithm is generally expensive, but specific methods have been implemented using FFT to speed\n up these calculations.\n\n\n Parameters\n ----------\n\n default : Image | Grayscale | Matrix\n The input DataContainer that contains the image to be processed.\n Can either be RGBA, greyscale, or a matrix type.\n In the case of RGB(A), the image is flattened to grayscale for the peak detection.\n image_mask : Grayscale | Matrix\n This object provides a mask to apply to the peak finding routines.\n Peaks found by any algorithm inside this mask are ignored.\n Should be of a datatype that can be static cast to booleans.\n If none, it is assumed that the entire image is valid for peak detection.\n center : list[int]\n For the high symmetry algorithm, this provides the center of symmetry\n to pass to the cross correlation routines.\n If none is provided, an autocenter routine is run to attempt to find the center of symmetry.\n min_dist : float\n The minimum distance between peaks.\n If the L2 distance (in pixels) of any pair of peaks is less than min_dist,\n they are considered to be the same, and one is discarded.\n This parameter applies to all algorithms.\n algorithm : str\n The name of the algorithm to use.\n prominence : float\n In the prominence and Laplacian of Gaussian algorithms, this defines the threshold\n above or below which objects must pass in order to be considered a peak.\n Does not apply to the high_symmetry algorithm.\n k : float\n This specifies the scaling of Gaussian filters between successive applications\n of Gaussian filters of increasing sigma.\n Default is chosen for ideal spherically symmetric peaks.\n Can be tuned for more bizarre looking peak structures.\n Applies only to the Laplacian of Gaussian algorithm.\n sigma : float\n The baseline standard deviation of the Gaussian filters,\n only for the Laplacian of Gaussian algorithm.\n max_power : int\n Describes the upper limit of the degree of exponentiation for the successive\n application of filters, only in the Laplacian of Gaussian algorithm.\n\n Returns\n -------\n fig : Plotly\n The Plotly figure so that the image can be visualized with its found peaks.\n blobs : Grayscale\n A blob mask that returns the regions around the found peaks.\n It is only valid for the high_symmetry and log routines.\n As the persistence algorithm is by definition hyperlocal, it has no notion of blobs\n throughout the detection process, and as such returns a unity mask.\n\n References\n ----------\n [1] Liu, Lai Chung. Chemistry in Action: Making Molecular Movies with Ultrafast\n Electron Diffraction and Data Science, Chapter 2. Springer Nature, 2020.\n\n [2] Huber, S. (2021). Persistent Homology in Data Science. In: Haber, P.,\n Lampoltshammer, T., Mayr, M., Plankensteiner, K. (eds) Data Science - Analytics\n and Applications. Springer Vieweg, Wiesbaden.\n https://doi.org/10.1007/978-3-658-32182-6_13\n\n [3] Edelsbrunner, H. and John L Harer (2010). Computational Topology. In: American\n Mathematical Society.\n\n [4] L. P. Ren\u00e9 de Cotret, M. R. Otto, M. J. Stern. and B. J. Siwick.\n An open-source software ecosystem for the interactive exploration of\n ultrafast electron scattering data, Advanced Structural and Chemical\n Imaging 4:11 (2018)\n\n [5] https://en.wikipedia.org/wiki/Blob_detection#The_Laplacian_of_Gaussian", + "parameters": [], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..9282893187 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Note: For \"gaussian\" and \"median\" type, you are only allowed an odd number for the kernel value.\n\nSee https://docs.opencv.org/4.x/d4/d13/tutorial_py_filtering.html for smoothing function information.\n\nInputs\n------\ndefault : Image\n The input image to apply smoothing to.", + "parameters": [ + { + "name": "kernel", + "type": "int", + "description": "The strength of the smoothing (larger = stronger smoothing)." + }, + { + "name": "smoothing_type", + "type": "select", + "description": "The type of smoothing function to use." + } + ], + "returns": [ + { + "name": null, + "type": "Image", + "description": "The smoothed image." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2a767ebc62 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "There are multiple input 'DataContainer' types for which\nthis function is applicable: 'Image', 'Grayscale', or 'Matrix'.\n\nOften in image analysis, it is necessary to determine subvolumes / subregions\ninside a given image, whether for object count (e.g. the counting of\ncells on a glass plate), or object dimensional analysis (determining coutours of\na region, centroid of a region relative to the pixel coordinate origin of the image,\ndetermining the semi-major or -minor axes of a region, etc.). This functionality\nis entirely provided by this node in a two-step process:\n\n- First, the regions of the INTEGER image are identified and labelled.\n- Second, the regions are analyzed.\n\nThe first step is provided by the morphology library of scikit-image's label function,\nwhile the second is provided by scikit-image's regionprops function.\n\nAfter processing, the results of this node are visualized in the main UI,\nwhere the user can see:\n- The input array / image.\n- The semi-major and semi-minor axes of the contour drawn relative to the contour centroid.\n- The contour centroid.\n- The countour bounding-box.\n- A mouse-hover utility that displays the contour information to the user.", + "parameters": [ + { + "name": "default", + "type": "Image | Grayscale", + "description": "The input node to this function.\nIf nothing is supplied, a demo test case is returned to illustrate the functionality of this node." + } + ], + "returns": [ + { + "name": "fig", + "type": "Plotly", + "description": "A Plotly figure containing the illustrated features as determined by this node." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3c3335bbd6 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "To multiply a scalar, use the MULTIPLY node.\n\nInputs\n------\na : Matrix\n The input matrix to be multiplied to input b.\nb : Matrix\n The input matrix to be multiplied to input a.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "The matrix result from the matrix multiplication." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..492c25db93 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "If the entered value is a list of scalar, it returns the multiplciative inverse 1/x for each element of the list.\n\nInputs\n------\ndefault : OrderedPair|Matrix\n The matrix or list of scalar to which we apply the invert.", + "parameters": [ + { + "name": "rcond", + "type": "float", + "description": "Set the rcond used to change small singular values to 0 for a more accurate result when calculating the pseuso-inverse of the matrix." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair|Matrix", + "description": "OrderedPair if the default input is an OrderedPair.\nx: the y input list of values.\ny: the list of inverse value of the y input.\n\nMatrix if the default input is a Matrix.\nm: the inverse matrix of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1e144558c9 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\na : Matrix\n The input matrix to be multiplied to input b.\nb : Matrix\n The input matrix to be multiplied to input a.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "The matrix result from the matrix multiplication." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..de3f5a4416 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault : Matrix\n The input Matrix", + "parameters": [ + { + "name": "axis", + "type": "int", + "description": "Axis along the matrix is shuffled. If axis is 0, shuffled by row and if it is 1, shuffled by column." + } + ], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "Shuffled input Matrix" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bd46ed1c19 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\na : Matrix\n The input matrix to be multiplied to input b", + "parameters": [ + { + "name": "axis", + "type": "int", + "description": "Axis along which to sort. Default is -1, which means sort along the last axis." + } + ], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "The matrix result from sorting." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/TRANSPOSE_MATRIX/a1-[autogen]/docstring.txt b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/TRANSPOSE_MATRIX/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..ef6e9daeee --- /dev/null +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/TRANSPOSE_MATRIX/a1-[autogen]/docstring.txt @@ -0,0 +1,11 @@ +The TRANSPOSE_MATRIX node takes an input 2D matrix and transposes it. + + Inputs + ------ + a : Matrix + The input matrix to be transposed + + Returns + ------- + Matrix + The transposed matrix diff --git a/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..763f18cf2d --- /dev/null +++ b/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair\n The input OrderedPair that we would like to invert the axes.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "The OrderedPair that is inverted." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..42037305d7 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "It is designed to have a frequency response that is as flat as possible in the pass band.\n\nInputs\n------\ndefault : OrderedPair\n The data to apply the butter filter to.", + "parameters": [ + { + "name": "filter_order", + "type": "int", + "description": "The intensity of the filter." + }, + { + "name": "critical_frequency", + "type": "int", + "description": "The frequency where the filter takes effect. For lowpass and highpass, it takes a scalar.\nFor bandpass and bandstop, it takes an array with the length of 2." + }, + { + "name": "btype", + "type": "select", + "description": "The type of the filter." + }, + { + "name": "sample_rate", + "type": "int", + "description": "The sample rate of the input signal." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: time domain\ny: filtered signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..450102d969 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/a1-[autogen]/docstring.json @@ -0,0 +1,37 @@ +{ + "description": "Through the FFT algorithm, the input vector will be transformed from a time domain into a frequency domain, which will be an ordered pair of arrays.\n\nInputs\n------\ndefault : OrderedPair\n The data to apply FFT to.", + "parameters": [ + { + "name": "window", + "type": "select", + "description": "the node will apply a window to the signal to avoid spectral leakage" + }, + { + "name": "real_signal", + "type": "boolean", + "description": "whether the input signal is real or complex" + }, + { + "name": "sample_rate", + "type": "int", + "description": "the sample rate of the signal, defaults to 1" + }, + { + "name": "display", + "type": "boolean", + "description": "whether the output would be graphed, set to false for pure data and true for data that is more suitable to be graphed" + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair if display is true", + "description": "x: frequency\ny: spectrum of the signal" + }, + { + "name": null, + "type": "DataFrame if display is false", + "description": "time: time domain\nfrequency: frequency domain\nreal: real section of the signal\nimag: imaginary section of the signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7db3f7f5f0 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/a1-[autogen]/docstring.json @@ -0,0 +1,42 @@ +{ + "description": "This filter takes a few inputs: the sample_rate (will be passed as a parameter if the target node is not connected), the window type of the filter, the cutoff frequency, and the number of taps (or length) of the filter.\n\nInputs\n------\ndefault : OrderedPair\n The data to apply a FIR filter to.", + "parameters": [ + { + "name": "sample_rate", + "type": "int", + "description": "the amount of samples within a second" + }, + { + "name": "filter_type", + "type": "select", + "description": "how the filter behaves" + }, + { + "name": "window", + "type": "select", + "description": "the window function used in the FIR" + }, + { + "name": "cutoff_low", + "type": "float", + "description": "the frequency cutoff to filter out the lower frequencies" + }, + { + "name": "cutoff_high", + "type": "float", + "description": "the frequency cutoff to filter out the upper frequencies" + }, + { + "name": "taps", + "type": "int", + "description": "the length of the filter" + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: time domain\ny: filtered signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e0d2095fff --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "With the IFFT algorithm, the input signal will be transformed from the frequency domain back into the time domain.\n\nInputs\n------\ndefault : OrderedPair\n The data to apply inverse FFT to.", + "parameters": [ + { + "name": "real_signal", + "type": "boolean", + "description": "whether the input signal is real (true) or complex (false)" + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x = time\ny = reconstructed signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..03682adb29 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "The returned value will be modified according to the PID parameters Kp, Ki, and Kd.\n\nInputs\n------\nsingle_input : Scalar\n The data to apply the PID function to.", + "parameters": [ + { + "name": "Kp", + "type": "float", + "description": "The proprotional PID parameter." + }, + { + "name": "Ki", + "type": "float", + "description": "The integral PID parameter." + }, + { + "name": "Kd", + "type": "float", + "description": "The derivative PID parameter." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "c: The PID function output." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..fee080d100 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "The default behaviour is to implement a 3-point moving average of the data.\n\nInputs\n------\ndefault : OrderedPair\n The data to apply the numpy savgol filter to.", + "parameters": [ + { + "name": "window_length", + "type": "int", + "description": "the length of the filter window, must be less than or equal to the size of the input" + }, + { + "name": "poly_order", + "type": "int", + "description": "the order of the polynomial used to fit the samples, must be less than or equal to the size of window_length" + } + ], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "x: time axis\ny: filtered signal" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..1692cc18c5 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "With the FFT algorithm, the input matrix will undergo a change of basis from the space domain into the frequency domain.\n\ngrayscale, dataframe, image, or matrix\n\nInputs\n------\ndefault : Grayscale|DataFrame|Image|Matrix\n The 2D data to apply 2DFFT to.", + "parameters": [ + { + "name": "real_signal", + "type": "bool", + "description": "true if the input matrix consists of only real numbers, false otherwise" + }, + { + "name": "color", + "type": "select", + "description": "if the input is an RGBA or RGB image, this parameter selects the color channel to perform the FFT on" + } + ], + "returns": [ + { + "name": null, + "type": "Matrix if input is Matrix", + "description": "m: the matrix after 2DFFT" + }, + { + "name": null, + "type": "DataFrame if input is Dataframe", + "description": "m: the dataframe after 2DFFT" + }, + { + "name": null, + "type": "Image", + "description": "the frequency spectrum of the color channel" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b4a26fc72c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\na: TextBlob\n The input text to be concatenated to input b\n\nb: TextBlob\n The input text to be concatenated to input a", + "parameters": [ + { + "name": "delimiter", + "type": "\"space\" | \"comma\" | \"semicolon\" | \"colon\" | \"new line\" | \"none\", default=\"space\"", + "description": "Select the delimiter to place between two text." + } + ], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": "The text result from concatenation." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f0374027a7 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : DataFrame\n The input dataframe to which we apply the conversion to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Matrix", + "description": "The matrix result from the conversion of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/examples/EX1/app.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/examples/EX1/app.json index 448a9b5ec7..dbefc14fb5 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/examples/EX1/app.json +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/examples/EX1/app.json @@ -54,8 +54,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 384, + "height": 288, "id": "TEXT_VIEW-228214a7-b6be-493b-b311-3022b731cb68", "type": "VISUALIZERS", "data": { @@ -88,138 +88,6 @@ }, "dragging": true }, - { - "width": 208, - "height": 96, - "id": "R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6", - "type": "GENERATORS", - "data": { - "id": "R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6", - "label": "R DATASET", - "func": "R_DATASET", - "type": "GENERATORS", - "ctrls": { - "dataset_key": { - "type": "select", - "default": "iris", - "options": [ - "ability.cov", - "airmiles", - "AirPassengers", - "airquality", - "anscombe", - "attenu", - "attitude", - "austres", - "BJsales", - "BOD", - "cars", - "ChickWeight", - "chickwts", - "co2", - "crimtab", - "discoveries", - "DNase", - "esoph", - "euro", - "EuStockMarkets", - "faithful", - "Formaldehyde", - "freeny", - "HairEyeColor", - "Harman23", - "Harman74", - "Indometh", - "infert", - "InsectSprays", - "iris", - "iris3", - "islands", - "JohnsonJohnson", - "LakeHuron", - "LifeCycleSavings", - "Loblolly", - "longley", - "lynx", - "morley", - "mtcars", - "nhtemp", - "Nile", - "nottem", - "npk", - "occupationalStatus", - "Orange", - "OrchardSprays", - "PlantGrowth", - "precip", - "presidents", - "pressure", - "Puromycin", - "quakes", - "randu", - "rivers", - "rock", - "Seatbelts", - "sleep", - "stackloss", - "sunspot.month", - "sunspot.year", - "sunspots", - "swiss", - "Theoph", - "Titanic", - "ToothGrowth", - "treering", - "trees", - "UCBAdmissions", - "UKDriverDeaths", - "UKgas", - "USAccDeaths", - "USArrests", - "USJudgeRatings", - "USPersonalExpenditure", - "VADeaths", - "volcano", - "warpbreaks", - "women", - "WorldPhones", - "WWWusage" - ], - "desc": null, - "functionName": "R_DATASET", - "param": "dataset_key", - "value": "airquality" - } - }, - "initCtrls": {}, - "outputs": [ - { - "name": "default", - "id": "default", - "type": "DataFrame", - "desc": "A DataContainer object containing the retrieved pandas DataFrame." - } - ], - "pip_dependencies": [ - { - "name": "rdatasets", - "v": "0.1.0" - } - ], - "path": "PYTHON/nodes/GENERATORS/SAMPLE_DATASETS/R_DATASET/R_DATASET.py", - "selected": false - }, - "position": { - "x": -1108.0780650709485, - "y": -823.4997659508415 - }, - "selected": false, - "positionAbsolute": { - "x": -1108.0780650709485, - "y": -823.4997659508415 - }, - "dragging": true - }, { "width": 160, "height": 160, @@ -264,8 +132,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "LINE-b936bc3c-9199-4a7b-b8ca-1a57a9ab4c0a", "type": "VISUALIZERS", "data": { @@ -296,19 +164,19 @@ "selected": false }, "position": { - "x": -448.09960951515916, - "y": -654.468220615062 + "x": -301.06622007553875, + "y": -717.6466301398989 }, "selected": false, "positionAbsolute": { - "x": -448.09960951515916, - "y": -654.468220615062 + "x": -301.06622007553875, + "y": -717.6466301398989 }, "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "LINE-cb11873f-7720-4b9f-b4c0-4d665d748b8a", "type": "VISUALIZERS", "data": { @@ -348,23 +216,61 @@ "y": -651.2243747293668 }, "dragging": true + }, + { + "width": 208, + "height": 96, + "id": "SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0", + "type": "GENERATORS", + "data": { + "id": "SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0", + "label": "SCIKIT LEARN DATASET", + "func": "SCIKIT_LEARN_DATASET", + "type": "GENERATORS", + "ctrls": { + "dataset_name": { + "type": "select", + "options": [ + "iris", + "diabetes", + "digits", + "linnerud", + "wine", + "breast_cancer" + ], + "default": "iris", + "desc": null, + "overload": null, + "functionName": "SCIKIT_LEARN_DATASET", + "param": "dataset_name", + "value": "iris" + } + }, + "initCtrls": {}, + "outputs": [ + { + "name": "default", + "id": "default", + "type": "DataFrame", + "desc": "A DataContainer object containing the retrieved pandas DataFrame." + } + ], + "path": "GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.py", + "selected": true + }, + "position": { + "x": -1179.2533628642557, + "y": -790.5389574962747 + }, + "selected": true, + "positionAbsolute": { + "x": -1179.2533628642557, + "y": -790.5389574962747 + }, + "dragging": true } ], "edges": [ - { - "source": "R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6", - "sourceHandle": "default", - "target": "DF_2_NP-c3182546-506f-428e-ab39-8870d2c38003", - "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6default-DF_2_NP-c3182546-506f-428e-ab39-8870d2c38003default" - }, - { - "source": "R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6", - "sourceHandle": "default", - "target": "LINE-cb11873f-7720-4b9f-b4c0-4d665d748b8a", - "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-6aa094ed-362b-47ed-b0f0-2c95ee2a5af6default-LINE-cb11873f-7720-4b9f-b4c0-4d665d748b8adefault" - }, { "source": "DF_2_NP-c3182546-506f-428e-ab39-8870d2c38003", "sourceHandle": "default", @@ -385,6 +291,20 @@ "target": "TEXT_VIEW-228214a7-b6be-493b-b311-3022b731cb68", "targetHandle": "default", "id": "reactflow__edge-TEXT-55b6e973-c612-43ad-8d7a-b911e16dc39cdefault-TEXT_VIEW-228214a7-b6be-493b-b311-3022b731cb68default" + }, + { + "source": "SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0", + "sourceHandle": "default", + "target": "DF_2_NP-c3182546-506f-428e-ab39-8870d2c38003", + "targetHandle": "default", + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0default-DF_2_NP-c3182546-506f-428e-ab39-8870d2c38003default" + }, + { + "source": "SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0", + "sourceHandle": "default", + "target": "LINE-cb11873f-7720-4b9f-b4c0-4d665d748b8a", + "targetHandle": "default", + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-af21c865-05de-409b-8ed9-3d5be39210e0default-LINE-cb11873f-7720-4b9f-b4c0-4d665d748b8adefault" } ], "viewport": { @@ -392,5 +312,6 @@ "y": 226.88940714410813, "zoom": 0.5 } - } + }, + "textNodes": [] } \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..4b83e45bee --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "It takes one dataframe type data and selects 3 different columns to generate the OrderedTriple type.\n\nInputs\n------\ndefault : DataFrame\n The input dataframe to which we apply the conversion to.", + "parameters": [ + { + "name": "x", + "type": "int", + "description": "The index of the column that represents the x-axis." + }, + { + "name": "y", + "type": "int", + "description": "The index of the column that represents the y-axis." + }, + { + "name": "z", + "type": "int", + "description": "The index of the column that represents the z-axis." + } + ], + "returns": [ + { + "name": null, + "type": "OrderedTriple", + "description": "The OrderedTriple result from the conversion of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/examples/EX1/app.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/examples/EX1/app.json index 36089b4ebd..b770a52fbb 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/examples/EX1/app.json +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/examples/EX1/app.json @@ -54,8 +54,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 384, + "height": 288, "id": "TEXT_VIEW-b70bbfaf-d726-4ff5-b243-1441ab16befc", "type": "VISUALIZERS", "data": { @@ -88,138 +88,6 @@ }, "dragging": true }, - { - "width": 208, - "height": 96, - "id": "R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141b", - "type": "GENERATORS", - "data": { - "id": "R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141b", - "label": "R DATASET", - "func": "R_DATASET", - "type": "GENERATORS", - "ctrls": { - "dataset_key": { - "type": "select", - "default": "iris", - "options": [ - "ability.cov", - "airmiles", - "AirPassengers", - "airquality", - "anscombe", - "attenu", - "attitude", - "austres", - "BJsales", - "BOD", - "cars", - "ChickWeight", - "chickwts", - "co2", - "crimtab", - "discoveries", - "DNase", - "esoph", - "euro", - "EuStockMarkets", - "faithful", - "Formaldehyde", - "freeny", - "HairEyeColor", - "Harman23", - "Harman74", - "Indometh", - "infert", - "InsectSprays", - "iris", - "iris3", - "islands", - "JohnsonJohnson", - "LakeHuron", - "LifeCycleSavings", - "Loblolly", - "longley", - "lynx", - "morley", - "mtcars", - "nhtemp", - "Nile", - "nottem", - "npk", - "occupationalStatus", - "Orange", - "OrchardSprays", - "PlantGrowth", - "precip", - "presidents", - "pressure", - "Puromycin", - "quakes", - "randu", - "rivers", - "rock", - "Seatbelts", - "sleep", - "stackloss", - "sunspot.month", - "sunspot.year", - "sunspots", - "swiss", - "Theoph", - "Titanic", - "ToothGrowth", - "treering", - "trees", - "UCBAdmissions", - "UKDriverDeaths", - "UKgas", - "USAccDeaths", - "USArrests", - "USJudgeRatings", - "USPersonalExpenditure", - "VADeaths", - "volcano", - "warpbreaks", - "women", - "WorldPhones", - "WWWusage" - ], - "desc": null, - "functionName": "R_DATASET", - "param": "dataset_key", - "value": "airquality" - } - }, - "initCtrls": {}, - "outputs": [ - { - "name": "default", - "id": "default", - "type": "DataFrame", - "desc": "A DataContainer object containing the retrieved pandas DataFrame." - } - ], - "pip_dependencies": [ - { - "name": "rdatasets", - "v": "0.1.0" - } - ], - "path": "PYTHON/nodes/GENERATORS/SAMPLE_DATASETS/R_DATASET/R_DATASET.py", - "selected": false - }, - "position": { - "x": -677.2257115768947, - "y": 320.5883946561946 - }, - "selected": false, - "positionAbsolute": { - "x": -677.2257115768947, - "y": 320.5883946561946 - }, - "dragging": true - }, { "width": 160, "height": 160, @@ -289,8 +157,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "TABLE-62eb9ff0-2e0f-4ea7-9770-be6a54d3c45f", "type": "VISUALIZERS", "data": { @@ -321,19 +189,19 @@ "selected": false }, "position": { - "x": 24.997712912767724, - "y": 32.889244940134404 + "x": 31.521079459966586, + "y": -20.38491519532323 }, "selected": false, "positionAbsolute": { - "x": 24.997712912767724, - "y": 32.889244940134404 + "x": 31.521079459966586, + "y": -20.38491519532323 }, "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "TABLE-de8a3838-f5c7-45e3-b045-2f838d8002d4", "type": "VISUALIZERS", "data": { @@ -364,19 +232,19 @@ "selected": false }, "position": { - "x": -451.59508901412926, - "y": 27.36861318594225 + "x": -508.1309324231863, + "y": -25.905546949515326 }, "selected": false, "positionAbsolute": { - "x": -451.59508901412926, - "y": 27.36861318594225 + "x": -508.1309324231863, + "y": -25.905546949515326 }, "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "SCATTER3D-9cb36053-f988-4c5f-a860-32c18d550b66", "type": "VISUALIZERS", "data": { @@ -407,19 +275,19 @@ "selected": false }, "position": { - "x": -449.45547957094664, - "y": 482.8784460901976 + "x": -444.01934078161423, + "y": 477.4423073008652 }, "selected": false, "positionAbsolute": { - "x": -449.45547957094664, - "y": 482.8784460901976 + "x": -444.01934078161423, + "y": 477.4423073008652 }, "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "SCATTER3D-cbfb4d9c-b0ff-4aaf-8aa5-6909ba2e2350", "type": "VISUALIZERS", "data": { @@ -459,23 +327,61 @@ "y": 496.85585704666755 }, "dragging": true + }, + { + "width": 208, + "height": 96, + "id": "SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6", + "type": "GENERATORS", + "data": { + "id": "SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6", + "label": "SCIKIT LEARN DATASET", + "func": "SCIKIT_LEARN_DATASET", + "type": "GENERATORS", + "ctrls": { + "dataset_name": { + "type": "select", + "options": [ + "iris", + "diabetes", + "digits", + "linnerud", + "wine", + "breast_cancer" + ], + "default": "iris", + "desc": null, + "overload": null, + "functionName": "SCIKIT_LEARN_DATASET", + "param": "dataset_name", + "value": "breast_cancer" + } + }, + "initCtrls": {}, + "outputs": [ + { + "name": "default", + "id": "default", + "type": "DataFrame", + "desc": "A DataContainer object containing the retrieved pandas DataFrame." + } + ], + "path": "GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.py", + "selected": false + }, + "position": { + "x": -745.491934881735, + "y": 336.62103541988444 + }, + "selected": false, + "positionAbsolute": { + "x": -745.491934881735, + "y": 336.62103541988444 + }, + "dragging": true } ], "edges": [ - { - "source": "R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141b", - "sourceHandle": "default", - "target": "TABLE-de8a3838-f5c7-45e3-b045-2f838d8002d4", - "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141bdefault-TABLE-de8a3838-f5c7-45e3-b045-2f838d8002d4default" - }, - { - "source": "R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141b", - "sourceHandle": "default", - "target": "SCATTER3D-9cb36053-f988-4c5f-a860-32c18d550b66", - "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141bdefault-SCATTER3D-9cb36053-f988-4c5f-a860-32c18d550b66default" - }, { "source": "DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83", "sourceHandle": "default", @@ -498,18 +404,32 @@ "id": "reactflow__edge-DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83default-TEXT-92862b82-03c7-45b3-955e-381cde864d77_" }, { - "source": "R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141b", + "source": "TEXT-92862b82-03c7-45b3-955e-381cde864d77", "sourceHandle": "default", - "target": "DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83", + "target": "TEXT_VIEW-b70bbfaf-d726-4ff5-b243-1441ab16befc", "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-777e46f9-b7c0-4cf4-91a5-ce61d713141bdefault-DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83default" + "id": "reactflow__edge-TEXT-92862b82-03c7-45b3-955e-381cde864d77default-TEXT_VIEW-b70bbfaf-d726-4ff5-b243-1441ab16befcdefault" }, { - "source": "TEXT-92862b82-03c7-45b3-955e-381cde864d77", + "source": "SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6", "sourceHandle": "default", - "target": "TEXT_VIEW-b70bbfaf-d726-4ff5-b243-1441ab16befc", + "target": "TABLE-de8a3838-f5c7-45e3-b045-2f838d8002d4", "targetHandle": "default", - "id": "reactflow__edge-TEXT-92862b82-03c7-45b3-955e-381cde864d77default-TEXT_VIEW-b70bbfaf-d726-4ff5-b243-1441ab16befcdefault" + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6default-TABLE-de8a3838-f5c7-45e3-b045-2f838d8002d4default" + }, + { + "source": "SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6", + "sourceHandle": "default", + "target": "SCATTER3D-9cb36053-f988-4c5f-a860-32c18d550b66", + "targetHandle": "default", + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6default-SCATTER3D-9cb36053-f988-4c5f-a860-32c18d550b66default" + }, + { + "source": "SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6", + "sourceHandle": "default", + "target": "DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83", + "targetHandle": "default", + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-25706df5-5161-49f1-b8f7-ddb6053a64a6default-DF_2_ORDERED_TRIPLE-a6cde1bc-b701-45c7-beac-24381f68ff83default" } ], "viewport": { @@ -517,5 +437,6 @@ "y": 226.88940714410813, "zoom": 0.5 } - } -} + }, + "textNodes": [] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/MATRIX_2_VECTOR/a1-[autogen]/docstring.txt b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MATRIX_2_VECTOR/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..eb94cefe15 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MATRIX_2_VECTOR/a1-[autogen]/docstring.txt @@ -0,0 +1,11 @@ +The MATRIX_2_VECTOR node takes a matrix and flatten it into vector type data. + + Inputs + ------ + default: Matrix + The input matrix that will be transformed into vector data type. + + Returns + ------- + Vector + Vector that is flatten from input matrix. diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..014ca4fb73 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Matrix\n The input matrix to which we apply the conversion to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "The dataframe result from the conversion of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..2b6d2e78b2 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : DataContainer\n The input numpy array which we apply the conversion to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "DataFrame", + "description": "The dataframe result from the conversion of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5f50b269fa --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "It then reshapes the z array into a 2D grid using the unique values of x and y.\n\nThe resulting 2D grid is used to create a Surface object with corresponding x, y, and z values.\n\nInputs\n------\ndefault : OrderedTriple\n The input OrderedTriple to which we apply the conversion to.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Surface", + "description": "The surface result from the conversion of the input." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_MATRIX/a1-[autogen]/docstring.txt b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_MATRIX/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..aab859a320 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_MATRIX/a1-[autogen]/docstring.txt @@ -0,0 +1,18 @@ +The VECTOR_2_MATRIX node takes a vector and transform it into matrix data type where + the shape is chosen by row and col parameters. + + Inputs + ------ + default: Vector + The input vector that will be transformed into matrix. + + Parameters + ---------- + row: int + number of rows for the new matrix + col: int + number of columns for the new matrix + Returns + ------- + Matrix + The matrix that is generated from the given vector and the parameters. diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f4b499d25c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Vector\n The input vector that will be the x axis of OrderedPair.\ny : Vector\n The input vector that will be the y axis of OrderedPair.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "OrderedPair", + "description": "The OrderedPair that is generated from the input vectors" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a2a030e12a --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "number of points by given factor\n\nInputs\n------\ndefault : Vector\n The input vector", + "parameters": [ + { + "name": "factor", + "type": "int", + "description": "Decimate factor which determines how many elements will be skipped\nbetween each selected element in the output vector" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Decimated vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..759655510b --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "into a single vector type by interleaving their elements\n\nInputs\n------\ndefault : Vector\n The input vector", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Decimated vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cfec0a60ce --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Vector\n The input vector", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Unique input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3ad77e944c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/a1-[autogen]/docstring.json @@ -0,0 +1,27 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to replace subset from", + "parameters": [ + { + "name": "indices", + "type": "Array", + "description": "specified indices to replace values at from the input vector" + }, + { + "name": "values", + "type": "Array", + "description": "subset of values to replace the specified indices" + }, + { + "name": "length", + "type": "int", + "description": "number of elements to replace from the input vector, default is 1 (this only applies when one index is specified for indices parameter)" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "The new vector with subset of elements replaced from the input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..76d636383f --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "the elements are in the reverse order\n\nInputs\n------\ndefault : Vector\n The input vector", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Reversed input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..5f5841619f --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to shift elements from", + "parameters": [ + { + "name": "shift", + "type": "int", + "description": "the number of places in which elements are moved (negative values will shift them to the left)" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "The new vector with elements shifted" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bf574a871f --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Vector\n The input vector", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Shuffled input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..356ad17dd3 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault : Vector\n The input vector", + "parameters": [ + { + "name": "reverse", + "type": "bool", + "description": "If False, sort in ascending order. If True, descending order." + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Sorted input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3c1d2cfcdd --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\ndefault : Vector\n The input vector", + "parameters": [ + { + "name": "index", + "type": "int", + "description": "index which you want to split your vector by" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "Splited input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..6ef11d74a4 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to delete from", + "parameters": [ + { + "name": "indices", + "type": "Array", + "description": "specified indices to delete value(s) at from the input vector" + }, + { + "name": "length", + "type": "int", + "description": "number of elements to delete from the input vector, default is 1 (this only applies when one index is specified for indices parameter)" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "The new vector with element(s) deleted from the input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..97703e1a9c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "Inputs\n------\nv : vector\n The input vector to index.", + "parameters": [ + { + "name": "index", + "type": "int", + "description": "The index of the vector to return." + } + ], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The scalar index of the input vector." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a9bb260f0c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "specified index.\n\nInputs\n------\nv : Vector\n The input vector to insert value.", + "parameters": [ + { + "name": "element", + "type": "int", + "description": "The value to add to the input vector." + }, + { + "name": "index", + "type": "int", + "description": "The index of the vector to insert value." + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "The new vector that contains the inserted value" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..f95ac246a4 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nv : vector\n The input vector to find the length of.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The length of the input vector." + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ecb1cd3741 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to use max peration", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The maximum value found from the input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..ecc3b9d45e --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to use min peration", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Scalar", + "description": "The minimum value found from the input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/a1-[autogen]/docstring.json b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d1d5e24718 --- /dev/null +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Inputs\n------\nv : Vector\n The input vector to return subset of values from", + "parameters": [ + { + "name": "indices", + "type": "Array", + "description": "specified indices to extract values at from the input vector" + }, + { + "name": "length", + "type": "int", + "description": "number of elements to extract from the input vector, default is 1 (this only applies when one index is specified for indices parameter)" + } + ], + "returns": [ + { + "name": null, + "type": "Vector", + "description": "The new vector with subset of elements extracted from the input vector" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..3611a62342 --- /dev/null +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair | DataFrame | Matrix | Image\n the DataContainer to be visualized in array format", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the visualization of the input in array format" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..20a16d5120 --- /dev/null +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair | Matrix\n the DataContainer to be visualized in matrix format.", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing visualization of the input in matrix format" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e15454d5df --- /dev/null +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : TextBlob\n the DataContainer to be visualized in text format", + "parameters": [], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": "the DataContainer containing text data" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/BAR/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/BAR/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..321028935a --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/BAR/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized in a bar chart", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Bar chart visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..d89d9f1451 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/a1-[autogen]/docstring.json @@ -0,0 +1,32 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|Scalar|Vector\n the DataContainer to be visualized", + "parameters": [ + { + "name": "relative_delta", + "type": "bool", + "description": "whether or not to show the relative delta from the last run along with big number" + }, + { + "name": "suffix", + "type": "str", + "description": "any suffix to show with big number" + }, + { + "name": "prefix", + "type": "str", + "description": "any prefix to show with big number" + }, + { + "name": "title", + "type": "str", + "description": "title of the plot, default = \"BIG_NUMBER\"" + } + ], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly big number visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..8254ebf3f2 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Inputs\n------\nprimary_trace : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized as the first figure\n\nsecondary_trace : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized as the second figure", + "parameters": [ + { + "name": "first_figure", + "type": "'bar' | 'line' | 'histogram' | 'scatter'", + "description": "plotly type to display as the first figure, default is 'scatter'" + }, + { + "name": "second_figure", + "type": "'bar' | 'line' | 'histogram' | 'scatter'", + "description": "plotly type to display as the second figure, default is 'line'" + } + ], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing Plotly visualization of both figures" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..93253b3b7f --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/a1-[autogen]/docstring.json @@ -0,0 +1,22 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|OrderedTriple|DataFrame|Vector|Matrix|Grayscale\n the DataContainer to be visualized", + "parameters": [ + { + "name": "show_text", + "type": "bool", + "description": "whether or not to show the text inside the heatmap color blocks" + }, + { + "name": "histogram", + "type": "bool", + "description": "whether or not to render a histogram of the image next to the render" + } + ], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly heatmap visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..43067d8c68 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Histogram visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..91eef6e670 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : Image\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Image visualization of the input image" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/LINE/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/LINE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..746c43401f --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/LINE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Line visualization of the input data" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/LINE/examples/EX1/app.json b/docs/nodes/VISUALIZERS/PLOTLY/LINE/examples/EX1/app.json index 90ddf52d8e..48a0bc0700 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/LINE/examples/EX1/app.json +++ b/docs/nodes/VISUALIZERS/PLOTLY/LINE/examples/EX1/app.json @@ -38,147 +38,18 @@ "selected": false }, "position": { - "x": 83.36011635478266, - "y": 444.9631272301297 + "x": 97.49407720704693, + "y": 504.76065391278627 }, "selected": false, "positionAbsolute": { - "x": 83.36011635478266, - "y": 444.9631272301297 + "x": 97.49407720704693, + "y": 504.76065391278627 }, "dragging": true }, { - "width": 208, - "height": 96, - "id": "R_DATASET-6c382bcf-a72e-488d-a784-eb21cb00839a", - "type": "GENERATORS", - "data": { - "id": "R_DATASET-6c382bcf-a72e-488d-a784-eb21cb00839a", - "label": "R DATASET", - "func": "R_DATASET", - "type": "GENERATORS", - "ctrls": { - "dataset_key": { - "type": "select", - "default": "iris", - "options": [ - "ability.cov", - "airmiles", - "AirPassengers", - "airquality", - "anscombe", - "attenu", - "attitude", - "austres", - "BJsales", - "BOD", - "cars", - "ChickWeight", - "chickwts", - "co2", - "crimtab", - "discoveries", - "DNase", - "esoph", - "euro", - "EuStockMarkets", - "faithful", - "Formaldehyde", - "freeny", - "HairEyeColor", - "Harman23", - "Harman74", - "Indometh", - "infert", - "InsectSprays", - "iris", - "iris3", - "islands", - "JohnsonJohnson", - "LakeHuron", - "LifeCycleSavings", - "Loblolly", - "longley", - "lynx", - "morley", - "mtcars", - "nhtemp", - "Nile", - "nottem", - "npk", - "occupationalStatus", - "Orange", - "OrchardSprays", - "PlantGrowth", - "precip", - "presidents", - "pressure", - "Puromycin", - "quakes", - "randu", - "rivers", - "rock", - "Seatbelts", - "sleep", - "stackloss", - "sunspot.month", - "sunspot.year", - "sunspots", - "swiss", - "Theoph", - "Titanic", - "ToothGrowth", - "treering", - "trees", - "UCBAdmissions", - "UKDriverDeaths", - "UKgas", - "USAccDeaths", - "USArrests", - "USJudgeRatings", - "USPersonalExpenditure", - "VADeaths", - "volcano", - "warpbreaks", - "women", - "WorldPhones", - "WWWusage" - ], - "functionName": "R_DATASET", - "param": "dataset_key", - "value": "iris" - } - }, - "outputs": [ - { - "name": "default", - "id": "default", - "type": "DataFrame" - } - ], - "pip_dependencies": [ - { - "name": "rdatasets", - "v": "0.1.0" - } - ], - "path": "PYTHON/nodes\\GENERATORS\\SAMPLE_DATASETS\\R_DATASET\\R_DATASET.py", - "selected": false - }, - "position": { - "x": 96.13358497687051, - "y": 215.36594613774037 - }, - "selected": false, - "positionAbsolute": { - "x": 96.13358497687051, - "y": 215.36594613774037 - }, - "dragging": true - }, - { - "width": 208, + "width": 210, "height": 96, "id": "TIMESERIES-511ecdda-9fd1-443e-95bb-2399e69b6484", "type": "GENERATORS", @@ -214,13 +85,13 @@ "selected": false }, "position": { - "x": 61.722775228768, - "y": 2.6454783507012394 + "x": 67.1589140181004, + "y": -18.011849048761917 }, "selected": false, "positionAbsolute": { - "x": 61.722775228768, - "y": 2.6454783507012394 + "x": 67.1589140181004, + "y": -18.011849048761917 }, "dragging": true }, @@ -254,13 +125,13 @@ "selected": false }, "position": { - "x": 469.8687147537621, - "y": 362.50128832181895 + "x": 467.6942592380291, + "y": 399.4670320892793 }, "selected": false, "positionAbsolute": { - "x": 469.8687147537621, - "y": 362.50128832181895 + "x": 467.6942592380291, + "y": 399.4670320892793 }, "dragging": true }, @@ -294,13 +165,13 @@ "selected": false }, "position": { - "x": 762.7310457743708, - "y": 116.02468713396252 + "x": 780.1266899002345, + "y": 114.937459376096 }, "selected": false, "positionAbsolute": { - "x": 762.7310457743708, - "y": 116.02468713396252 + "x": 780.1266899002345, + "y": 114.937459376096 }, "dragging": true }, @@ -334,13 +205,65 @@ "selected": false }, "position": { - "x": 403.6067599272868, - "y": -57.773384759895634 + "x": 417.740720779551, + "y": -119.7453669582851 }, "selected": false, "positionAbsolute": { - "x": 403.6067599272868, - "y": -57.773384759895634 + "x": 417.740720779551, + "y": -119.7453669582851 + }, + "dragging": true + }, + { + "width": 208, + "height": 96, + "id": "SCIKIT_LEARN_DATASET-1abc7ecd-da77-4b00-bfdc-8068bd315a63", + "type": "GENERATORS", + "data": { + "id": "SCIKIT_LEARN_DATASET-1abc7ecd-da77-4b00-bfdc-8068bd315a63", + "label": "SCIKIT LEARN DATASET", + "func": "SCIKIT_LEARN_DATASET", + "type": "GENERATORS", + "ctrls": { + "dataset_name": { + "type": "select", + "options": [ + "iris", + "diabetes", + "digits", + "linnerud", + "wine", + "breast_cancer" + ], + "default": "iris", + "desc": null, + "overload": null, + "functionName": "SCIKIT_LEARN_DATASET", + "param": "dataset_name", + "value": "iris" + } + }, + "initCtrls": {}, + "outputs": [ + { + "name": "default", + "id": "default", + "type": "DataFrame", + "desc": "A DataContainer object containing the retrieved pandas DataFrame." + } + ], + "path": "GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.py", + "selected": false + }, + "position": { + "x": 79.88477303643154, + "y": 236.65339910085572 + }, + "selected": false, + "positionAbsolute": { + "x": 79.88477303643154, + "y": 236.65339910085572 }, "dragging": true } @@ -354,18 +277,18 @@ "id": "reactflow__edge-TIMESERIES-511ecdda-9fd1-443e-95bb-2399e69b6484default-LINE-be1cb8d9-dc67-4567-8952-8b7eaeb9134ddefault" }, { - "source": "R_DATASET-6c382bcf-a72e-488d-a784-eb21cb00839a", + "source": "MATRIX-adb7407c-2ba3-4478-8c1a-2c0d2dc1f095", "sourceHandle": "default", - "target": "LINE-fba98010-ffc1-4864-8a5a-356f46f70a26", + "target": "LINE-b77bfca4-130d-46b6-9962-f53f605d7107", "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-6c382bcf-a72e-488d-a784-eb21cb00839adefault-LINE-fba98010-ffc1-4864-8a5a-356f46f70a26default" + "id": "reactflow__edge-MATRIX-adb7407c-2ba3-4478-8c1a-2c0d2dc1f095default-LINE-b77bfca4-130d-46b6-9962-f53f605d7107default" }, { - "source": "MATRIX-adb7407c-2ba3-4478-8c1a-2c0d2dc1f095", + "source": "SCIKIT_LEARN_DATASET-1abc7ecd-da77-4b00-bfdc-8068bd315a63", "sourceHandle": "default", - "target": "LINE-b77bfca4-130d-46b6-9962-f53f605d7107", + "target": "LINE-fba98010-ffc1-4864-8a5a-356f46f70a26", "targetHandle": "default", - "id": "reactflow__edge-MATRIX-adb7407c-2ba3-4478-8c1a-2c0d2dc1f095default-LINE-b77bfca4-130d-46b6-9962-f53f605d7107default" + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-1abc7ecd-da77-4b00-bfdc-8068bd315a63default-LINE-fba98010-ffc1-4864-8a5a-356f46f70a26default" } ], "viewport": { @@ -392,5 +315,6 @@ "i": "INPUT_PLACEHOLDER" } } - ] + ], + "textNodes": [] } \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..6b0d81a7b0 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "This is the output plotly graph from the 'plot_components_plotly' function from 'prophet.plot'.\nIt expects the trained Prophet model from the PROPHET_PREDICT node as input.\n\nIf 'run_forecast' was True in that node, the forecasted dataframe will be available as the 'm' attribute of the default input.\nOtherwise, this will make the predictions on the raw dataframe (in which case it will be the 'm' attribute of the default input).\n\nYou can tell if that forecasted dataframe is available via the 'extra' field of data input, 'run_forecast' (data.extra[\"run_forecast\"]).\n\nInputs\n------\ndefault : DataFrame\n the DataContainer to be visualized\n\ndata : DataContainer\n the DataContainer that holds prophet model and forecast data in the 'extra' field", + "parameters": [ + { + "name": "periods", + "type": "int", + "description": "The number of periods out to predict.\nOnly used if the node passed into this node (i.e. PROPHET_PREDICT) did NOT return the forecast.\nIf the forecast was included in the DataContainer, this parameter will be ignored.\n\nDefault = 365" + } + ], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly visualization of the prophet model" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..a193f7f13c --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": "This is the output plotly graph from the 'plot_plotly' function from 'prophet.plot'.\nIt expects the trained Prophet model from the PROPHET_PREDICT node as input.\n\nIf 'run_forecast' was True in that node, the forecasted dataframe will be available as the 'm' attribute of the default input.\nOtherwise, this will make the predictions on the raw dataframe (in which case it will be the 'm' attribute of the default input).\n\nYou can tell if that forecasted dataframe is available via the 'extra' field of data input, 'run_forecast' (data.extra[\"run_forecast\"]).\n\nInputs\n------\ndefault : DataFrame\n the DataContainer to be visualized\n\ndata : DataContainer\n the DataContainer that holds the prophet model and forecast data in the 'extra' field", + "parameters": [ + { + "name": "periods", + "type": "int", + "description": "The number of periods out to predict.\nOnly used if the node passed into this node (i.e. PROPHET_PREDICT) did NOT return the forecast.\nIf the forecast was included in the DataContainer, this parameter will be ignored.\n\nDefault = 365" + } + ], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly visualization of the prophet model" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..7e54c42391 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedPair|DataFrame|Matrix|Vector\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Scatter visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..9a6381369f --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedTriple|DataFrame\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly 3D Scatter visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..c5f8909e30 --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedTriple|DataFrame|Surface|Matrix\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly 3D Surface visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/TABLE/a1-[autogen]/docstring.json b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..e0d416e04d --- /dev/null +++ b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/a1-[autogen]/docstring.json @@ -0,0 +1,11 @@ +{ + "description": "Inputs\n------\ndefault : OrderedTriple|OrderedPair|DataFrame|Vector|Scalar\n the DataContainer to be visualized", + "parameters": [], + "returns": [ + { + "name": null, + "type": "Plotly", + "description": "the DataContainer containing the Plotly Table visualization" + } + ] +} \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/TABLE/examples/EX1/app.json b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/examples/EX1/app.json index 87eedd42eb..04de105f88 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/TABLE/examples/EX1/app.json +++ b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/examples/EX1/app.json @@ -3,7 +3,7 @@ "nodes": [ { "width": 150, - "height": 150, + "height": 180, "id": "LINSPACE-96f418c8-14ed-4457-abea-9520da6d5078", "type": "default", "data": { @@ -55,135 +55,6 @@ }, "dragging": true }, - { - "width": 150, - "height": 150, - "id": "R_DATASET-44eaa566-97ed-4dca-a9c5-0bcb7f680ad8", - "type": "GENERATORS", - "data": { - "id": "R_DATASET-44eaa566-97ed-4dca-a9c5-0bcb7f680ad8", - "label": "R DATASET", - "func": "R_DATASET", - "type": "GENERATORS", - "ctrls": { - "dataset_key": { - "type": "select", - "default": "iris", - "options": [ - "ability.cov", - "airmiles", - "AirPassengers", - "airquality", - "anscombe", - "attenu", - "attitude", - "austres", - "BJsales", - "BOD", - "cars", - "ChickWeight", - "chickwts", - "co2", - "crimtab", - "discoveries", - "DNase", - "esoph", - "euro", - "EuStockMarkets", - "faithful", - "Formaldehyde", - "freeny", - "HairEyeColor", - "Harman23", - "Harman74", - "Indometh", - "infert", - "InsectSprays", - "iris", - "iris3", - "islands", - "JohnsonJohnson", - "LakeHuron", - "LifeCycleSavings", - "Loblolly", - "longley", - "lynx", - "morley", - "mtcars", - "nhtemp", - "Nile", - "nottem", - "npk", - "occupationalStatus", - "Orange", - "OrchardSprays", - "PlantGrowth", - "precip", - "presidents", - "pressure", - "Puromycin", - "quakes", - "randu", - "rivers", - "rock", - "Seatbelts", - "sleep", - "stackloss", - "sunspot.month", - "sunspot.year", - "sunspots", - "swiss", - "Theoph", - "Titanic", - "ToothGrowth", - "treering", - "trees", - "UCBAdmissions", - "UKDriverDeaths", - "UKgas", - "USAccDeaths", - "USArrests", - "USJudgeRatings", - "USPersonalExpenditure", - "VADeaths", - "volcano", - "warpbreaks", - "women", - "WorldPhones", - "WWWusage" - ], - "functionName": "R_DATASET", - "param": "dataset_key", - "value": "iris" - } - }, - "outputs": [ - { - "name": "default", - "id": "default", - "type": "DataFrame" - } - ], - "pip_dependencies": [ - { - "name": "rdatasets", - "v": "0.1.0" - } - ], - "path": "PYTHON/nodes\\GENERATORS\\SAMPLE_DATASETS\\R_DATASET\\R_DATASET.py", - "selected": false - }, - "position": { - "x": 48.515937476087885, - "y": 399.8731016300469 - }, - "selected": false, - "positionAbsolute": { - "x": 48.515937476087885, - "y": 399.8731016300469 - }, - "dragging": true - }, { "width": 380, "height": 293, @@ -225,8 +96,8 @@ "dragging": true }, { - "width": 225, - "height": 226, + "width": 380, + "height": 293, "id": "TABLE-57c89935-c3df-4ba4-a8a5-f53534c47ee9", "type": "VISUALIZERS", "data": { @@ -263,22 +134,74 @@ "y": 379.87310163004656 }, "dragging": true + }, + { + "width": 208, + "height": 96, + "id": "SCIKIT_LEARN_DATASET-0fb48f9e-ebe6-427e-b770-7c2ba14dfe92", + "type": "GENERATORS", + "data": { + "id": "SCIKIT_LEARN_DATASET-0fb48f9e-ebe6-427e-b770-7c2ba14dfe92", + "label": "SCIKIT LEARN DATASET", + "func": "SCIKIT_LEARN_DATASET", + "type": "GENERATORS", + "ctrls": { + "dataset_name": { + "type": "select", + "options": [ + "iris", + "diabetes", + "digits", + "linnerud", + "wine", + "breast_cancer" + ], + "default": "iris", + "desc": null, + "overload": null, + "functionName": "SCIKIT_LEARN_DATASET", + "param": "dataset_name", + "value": "iris" + } + }, + "initCtrls": {}, + "outputs": [ + { + "name": "default", + "id": "default", + "type": "DataFrame", + "desc": "A DataContainer object containing the retrieved pandas DataFrame." + } + ], + "path": "GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.py", + "selected": false + }, + "position": { + "x": 59.534565049635674, + "y": 450.0003568907141 + }, + "selected": false, + "positionAbsolute": { + "x": 59.534565049635674, + "y": 450.0003568907141 + }, + "dragging": true } ], "edges": [ { - "source": "R_DATASET-44eaa566-97ed-4dca-a9c5-0bcb7f680ad8", + "source": "LINSPACE-96f418c8-14ed-4457-abea-9520da6d5078", "sourceHandle": "default", - "target": "TABLE-57c89935-c3df-4ba4-a8a5-f53534c47ee9", + "target": "TABLE-41e3d344-1ece-4eb2-adb8-dc944c80b49b", "targetHandle": "default", - "id": "reactflow__edge-R_DATASET-44eaa566-97ed-4dca-a9c5-0bcb7f680ad8default-TABLE-57c89935-c3df-4ba4-a8a5-f53534c47ee9default" + "id": "reactflow__edge-LINSPACE-96f418c8-14ed-4457-abea-9520da6d5078default-TABLE-41e3d344-1ece-4eb2-adb8-dc944c80b49bdefault" }, { - "source": "LINSPACE-96f418c8-14ed-4457-abea-9520da6d5078", + "source": "SCIKIT_LEARN_DATASET-0fb48f9e-ebe6-427e-b770-7c2ba14dfe92", "sourceHandle": "default", - "target": "TABLE-41e3d344-1ece-4eb2-adb8-dc944c80b49b", + "target": "TABLE-57c89935-c3df-4ba4-a8a5-f53534c47ee9", "targetHandle": "default", - "id": "reactflow__edge-LINSPACE-96f418c8-14ed-4457-abea-9520da6d5078default-TABLE-41e3d344-1ece-4eb2-adb8-dc944c80b49bdefault" + "id": "reactflow__edge-SCIKIT_LEARN_DATASET-0fb48f9e-ebe6-427e-b770-7c2ba14dfe92default-TABLE-57c89935-c3df-4ba4-a8a5-f53534c47ee9default" } ], "viewport": { @@ -305,5 +228,6 @@ "i": "INPUT_PLACEHOLDER" } } - ] + ], + "textNodes": [] } \ No newline at end of file diff --git a/nodeSidebar.json b/nodeSidebar.json index 5fece8e4c5..a3cc472dd2 100644 --- a/nodeSidebar.json +++ b/nodeSidebar.json @@ -146,7 +146,7 @@ "nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/FLEXIFORCE_25LB", "nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34" ], - "I/O > DAQ Boards": [ + "I/O > Daq Boards": [ "nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/READ_A0_PINS", "nodes/IO/INSTRUMENTS/DAQ_BOARDS/NI/COMING_FALL_2023/COMING_FALL_2023", "nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/READ_N_PINS" @@ -159,15 +159,6 @@ "nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B", "nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/SET_WAVEFORM_33510B" ], - "I/O > Digital Multimeters": [ - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/AC_CURRENT_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/CONNECTION_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/DC_CURRENT_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/DIODE_USB4065", - "nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/RESISTANCE_USB4065" - ], "I/O > MOCK": [ "nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/WEINSCHEL8320" ], From 13780a1da68cf8926f6a3f1ebff434ecb54585bb Mon Sep 17 00:00:00 2001 From: itsjoeoui Date: Sat, 7 Oct 2023 04:00:55 +0000 Subject: [PATCH 2/2] update: always rewrite template --- .../AI_ML/CLASSIFICATION/ACCURACY/ACCURACY.md | 44 +++++----------- .../ONE_HOT_ENCODING/ONE_HOT_ENCODING.md | 44 +++++----------- .../SUPPORT_VECTOR_MACHINE.md | 44 +++++----------- .../TORCHSCRIPT_CLASSIFIER.md | 27 ++++------ .../TRAIN_TEST_SPLIT/TRAIN_TEST_SPLIT.md | 44 +++++----------- .../NLP_CONNECT_VIT_GPT2.md | 40 +++++---------- .../HUGGING_FACE_PIPELINE.md | 27 +++++----- .../AI_ML/LOAD_MODEL/ONNX_MODEL/ONNX_MODEL.md | 31 ++++-------- .../NLP/COUNT_VECTORIZER/COUNT_VECTORIZER.md | 44 +++++----------- .../OBJECT_DETECTION/OBJECT_DETECTION.md | 44 +++++----------- .../PROPHET_PREDICT/PROPHET_PREDICT.md | 44 +++++----------- .../REGRESSION/LEAST_SQUARES/LEAST_SQUARES.md | 40 +++++---------- .../SEGMENTATION/DEEPLAB_V3/DEEPLAB_V3.md | 40 +++++---------- .../BART_LARGE_CNN/BART_LARGE_CNN.md | 40 +++++---------- .../EXTRACT_COLUMNS/EXTRACT_COLUMNS.md | 44 +++++----------- .../DATACONTAINER_TYPE/DATACONTAINER_TYPE.md | 26 +++------- .../DC_CONTENT_TYPE/DC_CONTENT_TYPE.md | 26 +++------- .../PRINT_DATACONTAINER.md | 26 +++------- .../EXTRACTORS/FILE/OPEN_IMAGE/OPEN_IMAGE.md | 44 +++++----------- .../FILE/OPEN_PARQUET/OPEN_PARQUET.md | 44 +++++----------- .../EXTRACTORS/FILE/READ_CSV/READ_CSV.md | 44 +++++----------- docs/nodes/EXTRACTORS/FILE/READ_S3/READ_S3.md | 40 +++++---------- .../PLOTLY_DATASET/PLOTLY_DATASET.md | 44 +++++----------- .../SCIKIT_LEARN_DATASET.md | 22 +++----- .../TEXT_DATASET/TEXT_DATASET.md | 44 +++++----------- .../SAMPLE_IMAGES/SKIMAGE/SKIMAGE.md | 40 ++++----------- .../BASIC_OSCILLATOR/BASIC_OSCILLATOR.md | 44 +++++----------- .../SIMULATIONS/CONSTANT/CONSTANT.md | 44 +++++----------- .../SIMULATIONS/FEEDBACK/FEEDBACK.md | 45 +++++------------ .../SIMULATIONS/LINSPACE/LINSPACE.md | 44 +++++----------- .../GENERATORS/SIMULATIONS/MATRIX/MATRIX.md | 44 +++++----------- .../SIMULATIONS/POPULATE/POPULATE.md | 22 +++----- .../nodes/GENERATORS/SIMULATIONS/RAND/RAND.md | 44 +++++----------- .../GENERATORS/SIMULATIONS/SCALAR/SCALAR.md | 31 ++++-------- .../SECOND_ORDER_SYSTEM.md | 44 +++++----------- .../nodes/GENERATORS/SIMULATIONS/SINE/SINE.md | 44 +++++----------- .../nodes/GENERATORS/SIMULATIONS/TEXT/TEXT.md | 33 +++++------- .../SIMULATIONS/TIMESERIES/TIMESERIES.md | 44 +++++----------- .../UNIX_TIMESTAMP/UNIX_TIMESTAMP.md | 36 ++++--------- .../SIMULATIONS/WAVEPACKET/WAVEPACKET.md | 39 +++++---------- .../FLEXIFORCE_25LB/FLEXIFORCE_25LB.md | 27 +++++----- .../ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34.md | 27 +++++----- .../IO/IMAGING/OPEN_WEBCAM/OPEN_WEBCAM.md | 28 +++-------- docs/nodes/IO/IMAGING/WEBCAM/WEBCAM.md | 44 +++------------- .../ATTENUATION_LDA602/ATTENUATION_LDA602.md | 22 +++----- .../U3/BASIC/READ_A0_PINS/READ_A0_PINS.md | 32 +++++------- .../BASIC/READ_N_PINS/READ_N_PINS.md | 32 +++++------- .../BURST_MODE_33510B/BURST_MODE_33510B.md | 27 +++------- .../RETURN_ERRORS_33510B.md | 27 +++------- .../CONNECTION_33510B/CONNECTION_33510B.md | 27 +++------- .../BASIC/ON_OFF_33510B/ON_OFF_33510B.md | 27 +++------- .../OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B.md | 27 +++------- .../SET_WAVEFORM_33510B.md | 27 +++------- .../MOCK/WEINSCHEL8320/WEINSCHEL8320.md | 46 +++++------------ .../AC_CURRENT_USB4065/AC_CURRENT_USB4065.md | 22 +++----- .../AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065.md | 22 +++----- .../CONNECTION_USB4065/CONNECTION_USB4065.md | 22 +++----- .../DC_CURRENT_USB4065/DC_CURRENT_USB4065.md | 22 +++----- .../DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065.md | 22 +++----- .../BASIC/DIODE_USB4065/DIODE_USB4065.md | 22 +++----- .../RESISTANCE_USB4065/RESISTANCE_USB4065.md | 22 +++----- .../ADVANCED_MEASUREMENTS_MDO3XXX.md | 32 ++++-------- .../TRIGGER_SETTINGS_MDO3XXX.md | 32 ++++-------- .../CONNECTION_MDO3XXX/CONNECTION_MDO3XXX.md | 28 +++-------- .../EXTRACT_TRACE_MDO3XXX.md | 32 ++++-------- .../MEASUREMENTS_MDO3XXX.md | 32 ++++-------- .../MEASURE_PHASE_MDO3XXX.md | 32 ++++-------- .../TERMINATION_MDO3XXX.md | 32 ++++-------- .../TRIGGER_CHANNEL_MDO3XXX.md | 32 ++++-------- .../TRIGGER_LEVEL_MDO3XXX.md | 32 ++++-------- .../INSTRUMENTS/QCODES/CLOSE_ALL/CLOSE_ALL.md | 27 +++++----- .../INSTRUMENTS/QCODES/LIST_VISA/LIST_VISA.md | 27 +++++----- .../QCODES/VISA_IDENTITY/VISA_IDENTITY.md | 27 +++++----- .../KEITHLEY/24XX/BASIC/IV_SWEEP/IV_SWEEP.md | 32 +++++------- .../OPEN_KEITHLEY_24XX/OPEN_KEITHLEY_24XX.md | 28 +++-------- .../MOTOR_DRIVER/STEPPER/POLULU/TIC/TIC.md | 32 +++++------- .../STEPPER/POLULU/TIC_KNOB/TIC_KNOB.md | 32 +++++------- docs/nodes/IO/PROTOCOLS/SCPI/IDN/IDN.md | 30 ++++------- .../SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE.md | 30 ++++------- .../SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL.md | 22 +++----- .../SERIAL_SINGLE_MEASUREMENT.md | 27 +++------- .../SERIAL_TIMESERIES/SERIAL_TIMESERIES.md | 27 +++------- .../ARMS/MECADEMIC/ACTIVATE/ACTIVATE.md | 22 +++----- .../ARMS/MECADEMIC/CONNECT/CONNECT.md | 22 +++----- .../IO/ROBOTICS/ARMS/MECADEMIC/DELAY/DELAY.md | 22 +++----- .../ARMS/MECADEMIC/DISCONNECT/DISCONNECT.md | 22 +++----- .../IO/ROBOTICS/ARMS/MECADEMIC/HOME/HOME.md | 22 +++----- .../ARMS/MECADEMIC/MOVE_JOINT/MOVE_JOINT.md | 22 +++----- .../ARMS/MECADEMIC/MOVE_LIN/MOVE_LIN.md | 22 +++----- .../ARMS/MECADEMIC/MOVE_POSE/MOVE_POSE.md | 22 +++----- .../SET_CART_LIN_VEL/SET_CART_LIN_VEL.md | 22 +++----- .../MECADEMIC/SET_JOINT_VEL/SET_JOINT_VEL.md | 22 +++----- .../FLOJOY_CLOUD_DOWNLOAD.md | 35 ++++++------- .../FLOJOY_CLOUD_UPLOAD.md | 35 ++++++------- .../INTERNAL_MEMORY/DS_LOAD/DS_LOAD.md | 24 +++------ .../BATCH_PROCESSOR/BATCH_PROCESSOR.md | 49 +++++++----------- .../LOCAL_FILE/LOCAL_FILE.md | 44 +++++----------- .../OPEN_MATLAB/OPEN_MATLAB.md | 44 +++++----------- .../REMOTE_FILE/REMOTE_FILE.md | 31 ++++-------- .../CONDITIONALS/CONDITIONAL/CONDITIONAL.md | 40 ++++----------- docs/nodes/LOGIC_GATES/LOOPS/APPEND/APPEND.md | 44 +++++----------- docs/nodes/LOGIC_GATES/LOOPS/LOOP/LOOP.md | 44 +++++----------- .../LOGIC_GATES/LOOP_TOOLS/BREAK/BREAK.md | 46 +++++++---------- .../LOOP_TOOLS/LOOP_INDEX/LOOP_INDEX.md | 44 +++++----------- docs/nodes/LOGIC_GATES/TIMERS/TIMER/TIMER.md | 44 +++++----------- docs/nodes/NUMPY/LINALG/CHOLESKY/CHOLESKY.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/DET/DET.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/EIG/EIG.md | 31 ++++-------- docs/nodes/NUMPY/LINALG/EIGH/EIGH.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/EIGVALS/EIGVALS.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/EIGVALSH/EIGVALSH.md | 34 ++++--------- docs/nodes/NUMPY/LINALG/INV/INV.md | 33 ++++-------- .../NUMPY/LINALG/MATRIX_POWER/MATRIX_POWER.md | 31 ++++-------- docs/nodes/NUMPY/LINALG/PINV/PINV.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/QR/QR.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/SLOGDET/SLOGDET.md | 33 ++++-------- docs/nodes/NUMPY/LINALG/SVD/SVD.md | 33 ++++-------- .../nodes/NUMPY/LINALG/TENSORINV/TENSORINV.md | 33 ++++-------- .../nodes/SCIPY/SIGNAL/ARGRELMAX/ARGRELMAX.md | 33 ++++-------- .../nodes/SCIPY/SIGNAL/ARGRELMIN/ARGRELMIN.md | 33 ++++-------- docs/nodes/SCIPY/SIGNAL/BSPLINE/BSPLINE.md | 32 ++++-------- docs/nodes/SCIPY/SIGNAL/CUBIC/CUBIC.md | 33 ++++-------- docs/nodes/SCIPY/SIGNAL/DECIMATE/DECIMATE.md | 32 ++++-------- docs/nodes/SCIPY/SIGNAL/DETREND/DETREND.md | 33 ++++-------- .../SCIPY/SIGNAL/GAUSS_SPLINE/GAUSS_SPLINE.md | 33 ++++-------- docs/nodes/SCIPY/SIGNAL/HILBERT/HILBERT.md | 31 ++++-------- .../SCIPY/SIGNAL/KAISER_BETA/KAISER_BETA.md | 32 ++++-------- .../SCIPY/SIGNAL/PERIODOGRAM/PERIODOGRAM.md | 32 ++++-------- .../nodes/SCIPY/SIGNAL/QUADRATIC/QUADRATIC.md | 33 ++++-------- .../SIGNAL/SAVGOL_FILTER/SAVGOL_FILTER.md | 33 ++++-------- docs/nodes/SCIPY/SIGNAL/STFT/STFT.md | 31 ++++-------- docs/nodes/SCIPY/SIGNAL/WELCH/WELCH.md | 33 ++++-------- docs/nodes/SCIPY/STATS/ANDERSON/ANDERSON.md | 33 ++++-------- docs/nodes/SCIPY/STATS/BAYES_MVS/BAYES_MVS.md | 33 ++++-------- .../SCIPY/STATS/BINOM_TEST/BINOM_TEST.md | 33 ++++-------- docs/nodes/SCIPY/STATS/DESCRIBE/DESCRIBE.md | 33 ++++-------- docs/nodes/SCIPY/STATS/GSTD/GSTD.md | 32 ++++-------- docs/nodes/SCIPY/STATS/GZSCORE/GZSCORE.md | 31 ++++-------- .../SCIPY/STATS/JARQUE_BERA/JARQUE_BERA.md | 31 ++++-------- docs/nodes/SCIPY/STATS/KURTOSIS/KURTOSIS.md | 33 ++++-------- .../SCIPY/STATS/KURTOSISTEST/KURTOSISTEST.md | 33 ++++-------- docs/nodes/SCIPY/STATS/MOMENT/MOMENT.md | 33 ++++-------- docs/nodes/SCIPY/STATS/MVSDIST/MVSDIST.md | 33 ++++-------- .../SCIPY/STATS/NORMALTEST/NORMALTEST.md | 33 ++++-------- docs/nodes/SCIPY/STATS/SEM/SEM.md | 31 ++++-------- docs/nodes/SCIPY/STATS/SHAPIRO/SHAPIRO.md | 33 ++++-------- docs/nodes/SCIPY/STATS/SIGMACLIP/SIGMACLIP.md | 31 ++++-------- docs/nodes/SCIPY/STATS/SKEW/SKEW.md | 33 ++++-------- docs/nodes/SCIPY/STATS/SKEWTEST/SKEWTEST.md | 33 ++++-------- docs/nodes/SCIPY/STATS/TMAX/TMAX.md | 33 ++++-------- docs/nodes/SCIPY/STATS/TMIN/TMIN.md | 33 ++++-------- docs/nodes/SCIPY/STATS/TRIM1/TRIM1.md | 33 ++++-------- docs/nodes/SCIPY/STATS/TRIMBOTH/TRIMBOTH.md | 32 ++++-------- docs/nodes/SCIPY/STATS/TRIM_MEAN/TRIM_MEAN.md | 32 ++++-------- .../SCIPY/STATS/TTEST_1SAMP/TTEST_1SAMP.md | 31 ++++-------- docs/nodes/SCIPY/STATS/VARIATION/VARIATION.md | 31 ++++-------- .../SCIPY/STATS/YEOJOHNSON/YEOJOHNSON.md | 33 ++++-------- docs/nodes/SCIPY/STATS/ZSCORE/ZSCORE.md | 33 ++++-------- docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/ABS.md | 44 +++++----------- docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/ADD.md | 44 +++++----------- .../TRANSFORMERS/ARITHMETIC/DIVIDE/DIVIDE.md | 44 +++++----------- .../ARITHMETIC/MULTIPLY/MULTIPLY.md | 44 +++++----------- .../ARITHMETIC/SUBTRACT/SUBTRACT.md | 44 +++++----------- .../CALCULUS/DIFFERENTIATE/DIFFERENTIATE.md | 44 +++++----------- .../DOUBLE_DEFINITE_INTEGRAL.md | 45 +++++------------ .../DOUBLE_INDEFINITE_INTEGRAL.md | 45 +++++------------ .../CALCULUS/INTEGRATE/INTEGRATE.md | 44 +++++----------- .../CHANNEL_MERGE/CHANNEL_MERGE.md | 31 ++++-------- .../CHANNEL_SPLIT/CHANNEL_SPLIT.md | 31 ++++-------- .../EDGE_DETECTION/EDGE_DETECTION.md | 44 +++++----------- .../EXTREMA_DETERMINATION.md | 31 ++++-------- .../IMAGE_SMOOTHING/IMAGE_SMOOTHING.md | 44 +++++----------- .../REGION_PROPERTIES/REGION_PROPERTIES.md | 31 ++++-------- .../DOT_PRODUCT/DOT_PRODUCT.md | 33 +++++------- .../MATRIX_MANIPULATION/INVERT/INVERT.md | 44 +++++----------- .../MATRIX_MANIPULATION/MATMUL/MATMUL.md | 44 +++++----------- .../SHUFFLE_MATRIX/SHUFFLE_MATRIX.md | 31 ++++-------- .../SORT_MATRIX/SORT_MATRIX.md | 31 ++++-------- .../ORDERED_PAIR_XY_INVERT.md | 33 +++++------- .../SIGNAL_PROCESSING/BUTTER/BUTTER.md | 44 +++++----------- .../TRANSFORMERS/SIGNAL_PROCESSING/FFT/FFT.md | 44 +++++----------- .../TRANSFORMERS/SIGNAL_PROCESSING/FIR/FIR.md | 44 +++++----------- .../SIGNAL_PROCESSING/IFFT/IFFT.md | 44 +++++----------- .../TRANSFORMERS/SIGNAL_PROCESSING/PID/PID.md | 44 +++++----------- .../SIGNAL_PROCESSING/SAVGOL/SAVGOL.md | 40 +++++---------- .../TWO_DIMENSIONAL_FFT.md | 40 ++++----------- .../TEXT_CONCAT/TEXT_CONCAT.md | 39 ++++++--------- .../TYPE_CASTING/DF_2_NP/DF_2_NP.md | 44 +++++----------- .../DF_2_ORDERED_TRIPLE.md | 44 +++++----------- .../TYPE_CASTING/MAT_2_DF/MAT_2_DF.md | 44 +++++----------- .../TYPE_CASTING/NP_2_DF/NP_2_DF.md | 44 +++++----------- .../ORDERED_TRIPLE_2_SURFACE.md | 44 +++++----------- .../VECTOR_2_ORDERED_PAIR.md | 31 ++++-------- .../DECIMATE_VECTOR/DECIMATE_VECTOR.md | 31 ++++-------- .../INTERLEAVE_VECTOR/INTERLEAVE_VECTOR.md | 31 ++++-------- .../REMOVE_DUPLICATES_VECTOR.md | 31 ++++-------- .../REPLACE_SUBSET/REPLACE_SUBSET.md | 26 +++------- .../REVERSE_VECTOR/REVERSE_VECTOR.md | 31 ++++-------- .../SHIFT_VECTOR/SHIFT_VECTOR.md | 26 +++------- .../SHUFFLE_VECTOR/SHUFFLE_VECTOR.md | 39 ++++++--------- .../SORT_VECTOR/SORT_VECTOR.md | 31 ++++-------- .../SPLIT_VECTOR/SPLIT_VECTOR.md | 31 ++++-------- .../VECTOR_DELETE/VECTOR_DELETE.md | 26 +++------- .../VECTOR_INDEXING/VECTOR_INDEXING.md | 39 ++++++--------- .../VECTOR_INSERT/VECTOR_INSERT.md | 26 +++------- .../VECTOR_LENGTH/VECTOR_LENGTH.md | 31 ++++-------- .../VECTOR_MAX/VECTOR_MAX.md | 39 ++++++--------- .../VECTOR_MIN/VECTOR_MIN.md | 39 ++++++--------- .../VECTOR_SUBSET/VECTOR_SUBSET.md | 38 ++++++-------- .../DATA_STRUCTURE/ARRAY_VIEW/ARRAY_VIEW.md | 44 +++++----------- .../DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.md | 44 +++++----------- .../DATA_STRUCTURE/TEXT_VIEW/TEXT_VIEW.md | 19 +++---- docs/nodes/VISUALIZERS/PLOTLY/BAR/BAR.md | 44 +++++----------- .../PLOTLY/BIG_NUMBER/BIG_NUMBER.md | 44 +++++----------- .../VISUALIZERS/PLOTLY/COMPOSITE/COMPOSITE.md | 50 +++++-------------- .../VISUALIZERS/PLOTLY/HEATMAP/HEATMAP.md | 31 ++++-------- .../VISUALIZERS/PLOTLY/HISTOGRAM/HISTOGRAM.md | 50 +++++-------------- docs/nodes/VISUALIZERS/PLOTLY/IMAGE/IMAGE.md | 44 +++++----------- docs/nodes/VISUALIZERS/PLOTLY/LINE/LINE.md | 44 +++++----------- .../PROPHET_COMPONENTS/PROPHET_COMPONENTS.md | 44 +++++----------- .../PLOTLY/PROPHET_PLOT/PROPHET_PLOT.md | 44 +++++----------- .../VISUALIZERS/PLOTLY/SCATTER/SCATTER.md | 44 +++++----------- .../VISUALIZERS/PLOTLY/SCATTER3D/SCATTER3D.md | 44 +++++----------- .../VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.md | 44 +++++----------- docs/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.md | 44 +++++----------- 225 files changed, 2361 insertions(+), 5469 deletions(-) diff --git a/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/ACCURACY.md b/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/ACCURACY.md index fdd4c54bb7..f46c6d836f 100644 --- a/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/ACCURACY.md +++ b/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/ACCURACY.md @@ -1,13 +1,9 @@ ---- -title: ACCURACY -description: The ACCURACY node takes two dataframes with the true and predicted labels from a classification task, and indicates what proportion of the predictions were correct. These dataframes should both be single columns. -keywords: [AI, Classification, Python, DataFrame, Accuracy, Prediction] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Determine whether predictions are accurate - - {App1} + GLink='AI_ML/CLASSIFICATION/ACCURACY' + nodeLabel='ACCURACY'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/CLASSIFICATION/ACCURACY) diff --git a/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/ONE_HOT_ENCODING.md b/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/ONE_HOT_ENCODING.md index 5a4eaad427..4b2226b9bb 100644 --- a/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/ONE_HOT_ENCODING.md +++ b/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/ONE_HOT_ENCODING.md @@ -1,13 +1,9 @@ ---- -title: ONE_HOT_ENCODING -description: Discover the power of Python in AI/ML classification with the ONE_HOT_ENCODING node that creates encoding from a dataframe and columns dataframe that contain categorical features. -keywords: [AI, Classification, Python, DataFrame, Columns Dataframe, Categorical Features, Encoding] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a one hot encoding from a dataframe - - {App1} + GLink='AI_ML/CLASSIFICATION/ONE_HOT_ENCODING' + nodeLabel='ONE_HOT_ENCODING'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/CLASSIFICATION/ONE_HOT_ENCODING) diff --git a/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/SUPPORT_VECTOR_MACHINE.md b/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/SUPPORT_VECTOR_MACHINE.md index 44372fc1db..5dc6d49f0a 100644 --- a/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/SUPPORT_VECTOR_MACHINE.md +++ b/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/SUPPORT_VECTOR_MACHINE.md @@ -1,13 +1,9 @@ ---- -title: SUPPORT_VECTOR_MACHINE -description: Train a support vector machine model for classification tasks by taking two dataframes of label and feature from labelled training data and a dataframe of unlabelled input data. -keywords: [AI, Classification, Python, DataFrame, Train, Vector, Machine Model] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Train a support vector machine model - - {App1} + GLink='AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE' + nodeLabel='SUPPORT_VECTOR_MACHINE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/CLASSIFICATION/SUPPORT_VECTOR_MACHINE) diff --git a/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/TORCHSCRIPT_CLASSIFIER.md b/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/TORCHSCRIPT_CLASSIFIER.md index e75cefcb59..083a193c7b 100644 --- a/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/TORCHSCRIPT_CLASSIFIER.md +++ b/docs/nodes/AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER/TORCHSCRIPT_CLASSIFIER.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Execute a torchscript classifier against an image - - {App1} + GLink='AI_ML/CLASSIFICATION/TORCHSCRIPT_CLASSIFIER' + nodeLabel='TORCHSCRIPT_CLASSIFIER'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -53,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/TRAIN_TEST_SPLIT.md b/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/TRAIN_TEST_SPLIT.md index fd679280e5..79215bc3a1 100644 --- a/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/TRAIN_TEST_SPLIT.md +++ b/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/TRAIN_TEST_SPLIT.md @@ -1,13 +1,9 @@ ---- -title: TRAIN_TEST_SPLIT -description: The TRAIN_TEST_SPLIT node is used to split data into test and training data in Python, according to a specified size, before any Machine Learning tasks occur. -keywords: [AI, Classification, Python, DataFrame, Train, Training, Test, Machine Learning, ML Model] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Split the data for testing and training - - {App1} + GLink='AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT' + nodeLabel='TRAIN_TEST_SPLIT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/CLASSIFICATION/TRAIN_TEST_SPLIT) diff --git a/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/NLP_CONNECT_VIT_GPT2.md b/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/NLP_CONNECT_VIT_GPT2.md index ac295d6c07..a0864ee9fb 100644 --- a/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/NLP_CONNECT_VIT_GPT2.md +++ b/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/NLP_CONNECT_VIT_GPT2.md @@ -1,13 +1,9 @@ ---- -title: NLP_CONNECT_VIT_GPT2 -description: Enhance image captioning using Python with the NLP_CONNECT_VIT_GPT2 node that captions an input image and produces an output string wrapped in a dataframe. -keywords: [AI, Python, DataFrame, Image Caption, Machine Learning, ML] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Caption and image - - {App1} + GLink='AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2' + nodeLabel='NLP_CONNECT_VIT_GPT2'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/IMAGE_CAPTIONING/NLP_CONNECT_VIT_GPT2) diff --git a/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/HUGGING_FACE_PIPELINE.md b/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/HUGGING_FACE_PIPELINE.md index 15c4fef572..474413bec9 100644 --- a/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/HUGGING_FACE_PIPELINE.md +++ b/docs/nodes/AI_ML/IMAGE_CLASSIFICATION/HUGGING_FACE_PIPELINE/HUGGING_FACE_PIPELINE.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,33 +12,29 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Process and classify an image - - - {App1} + - + - + [//]: # (Appendix) @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/ONNX_MODEL.md b/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/ONNX_MODEL.md index dde7dc09a7..bf9898c181 100644 --- a/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/ONNX_MODEL.md +++ b/docs/nodes/AI_ML/LOAD_MODEL/ONNX_MODEL/ONNX_MODEL.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Make predictions from a serialized ONNX model - - {App1} + GLink='AI_ML/LOAD_MODEL/ONNX_MODEL' + nodeLabel='ONNX_MODEL'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/COUNT_VECTORIZER.md b/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/COUNT_VECTORIZER.md index af56de463c..f320900470 100644 --- a/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/COUNT_VECTORIZER.md +++ b/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/COUNT_VECTORIZER.md @@ -1,13 +1,9 @@ ---- -title: COUNT_VECTORIZER -description: Optimise NLP tasks with Python using Flojoy's COUNT_VECTORIZER node. It efficiently analyses text (matrix, vector, or dataframe) and returns a matrix with unique token counts for each sentence. -keywords: [AI, Python, DataFrame, NLP, Text, Tokens, Matrix, Vector] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Transform text to words and a matrix - - {App1} + GLink='AI_ML/NLP/COUNT_VECTORIZER' + nodeLabel='COUNT_VECTORIZER'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/NLP/COUNT_VECTORIZER) diff --git a/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/OBJECT_DETECTION.md b/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/OBJECT_DETECTION.md index 40ee7f9221..194cf3c467 100644 --- a/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/OBJECT_DETECTION.md +++ b/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/OBJECT_DETECTION.md @@ -1,13 +1,9 @@ ---- -title: OBJECT_DETECTION -description: Streamline object detection with Python using Flojoy's OBJECT_DETECTION node that detects objects in the input image, and returns an 'image' DataContainer with those objects highlighted. -keywords: [AI, ML, Python, Object Detection, Image, jpeg, DataContainer] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Detect and display objects in an image - - {App1} + GLink='AI_ML/OBJECT_DETECTION/OBJECT_DETECTION' + nodeLabel='OBJECT_DETECTION'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/OBJECT_DETECTION/OBJECT_DETECTION) diff --git a/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/PROPHET_PREDICT.md b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/PROPHET_PREDICT.md index 370f54ad10..1e9ae4e566 100644 --- a/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/PROPHET_PREDICT.md +++ b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/PROPHET_PREDICT.md @@ -1,13 +1,9 @@ ---- -title: PROPHET_PREDICT -description: Leverage Python's power in time series forecasting with Flojoy's PROPHET_PREDICT node that creates a forecast, identifies the trend components, and plots it in Plotly. -keywords: [AI, ML, Python, Predict, Time Series, Forecast, Trend, Plotly, Dataframe, DataContainer] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Train a Prophet model and run a prediction forecast - - {App1} + GLink='AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT' + nodeLabel='PROPHET_PREDICT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT) diff --git a/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/LEAST_SQUARES.md b/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/LEAST_SQUARES.md index 9cfd6f6d25..3e732316b0 100644 --- a/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/LEAST_SQUARES.md +++ b/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/LEAST_SQUARES.md @@ -1,13 +1,9 @@ ---- -title: LEAST_SQUARES -description: Enhance regression analysis in Python with Flojoy's LEAST_SQUARES node which will empower you to optimize model accuracy and make data-driven decisions efficiently. -keywords: [AI, ML, Python, Regression, Coefficient, Regression Weights, OrderedPair] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Calculate the coefficients that minimize errors from data points - - {App1} + GLink='AI_ML/REGRESSION/LEAST_SQUARES' + nodeLabel='LEAST_SQUARES'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/REGRESSION/LEAST_SQUARES) diff --git a/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/DEEPLAB_V3.md b/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/DEEPLAB_V3.md index 6e6710509b..458c3cfef5 100644 --- a/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/DEEPLAB_V3.md +++ b/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/DEEPLAB_V3.md @@ -1,13 +1,9 @@ ---- -title: DEEPLAB_V3 -description: Master image segmentation in Python with Flojoy's DEEPLAB_V3 node. Unlock precise object detection and semantic segmentation capabilities for AI/ML projects. -keywords: [AI, ML, Python, Segmentation, DataContainer] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Produce a segmentation mask from an image - - {App1} + GLink='AI_ML/SEGMENTATION/DEEPLAB_V3' + nodeLabel='DEEPLAB_V3'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/SEGMENTATION/DEEPLAB_V3) diff --git a/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/BART_LARGE_CNN.md b/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/BART_LARGE_CNN.md index e27b5635a6..d8266ea63c 100644 --- a/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/BART_LARGE_CNN.md +++ b/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/BART_LARGE_CNN.md @@ -1,13 +1,9 @@ ---- -title: BART_LARGE_CNN -description: Supercharge text summarization with Python and Flojoy's BART_LARGE_CNN node that takes an input dataframe with multiple rows and a single column, and produces a dataframe with a single "summary_text" column. -keywords: [AI, ML, Python, Text Summarization, Text Summary, Content Analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Produce a dataframe with a single "summary_text" column - - {App1} + GLink='AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN' + nodeLabel='BART_LARGE_CNN'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/AI_ML/TEXT_SUMMARIZATION/BART_LARGE_CNN) diff --git a/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/EXTRACT_COLUMNS.md b/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/EXTRACT_COLUMNS.md index 3cfb7b0e5a..e9a42a85a4 100644 --- a/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/EXTRACT_COLUMNS.md +++ b/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/EXTRACT_COLUMNS.md @@ -1,13 +1,9 @@ ---- -title: EXTRACT_COLUMNS -description: Efficiently extract specific columns from DataFrames using Python with Flojoy's EXTRACT_COLUMNS node. Streamline data manipulation and analysis. -keywords: [Python, Extractor, Extract, Dataframe column extraction, Python column selection, Efficient data manipulation, Extracting DataFframe columns, Flojoy Extract Columns node, Streamlining data analysis, Python data extraction, Data column filtering, Dataframe column manipulation, Extracting specific columns] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Extract specific columns from a dataframe - - {App1} + GLink='EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS' + nodeLabel='EXTRACT_COLUMNS'> - + - + [//]: # (Appendix) -## Appendix - import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/EXTRACTORS/DATAFRAME/EXTRACT_COLUMNS) diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/DATACONTAINER_TYPE.md b/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/DATACONTAINER_TYPE.md index 135386c8b9..a045196538 100644 --- a/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/DATACONTAINER_TYPE.md +++ b/docs/nodes/EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE/DATACONTAINER_TYPE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### DATACONTAINER_TYPE example - - {App1} + GLink='EXTRACTORS/DEBUGGING/DATACONTAINER_TYPE' + nodeLabel='DATACONTAINER_TYPE'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/DC_CONTENT_TYPE.md b/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/DC_CONTENT_TYPE.md index dd62a900b5..1b170619a1 100644 --- a/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/DC_CONTENT_TYPE.md +++ b/docs/nodes/EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE/DC_CONTENT_TYPE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### DC_CONTENT_TYPE example - - {App1} + GLink='EXTRACTORS/DEBUGGING/DC_CONTENT_TYPE' + nodeLabel='DC_CONTENT_TYPE'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/PRINT_DATACONTAINER.md b/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/PRINT_DATACONTAINER.md index 57c9c7e5b0..de42b0a91b 100644 --- a/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/PRINT_DATACONTAINER.md +++ b/docs/nodes/EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER/PRINT_DATACONTAINER.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### PRINT_DATACONTAINER example - - {App1} + GLink='EXTRACTORS/DEBUGGING/PRINT_DATACONTAINER' + nodeLabel='PRINT_DATACONTAINER'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/OPEN_IMAGE.md b/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/OPEN_IMAGE.md index 4dcaf18280..0d582c363b 100644 --- a/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/OPEN_IMAGE.md +++ b/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/OPEN_IMAGE.md @@ -1,13 +1,9 @@ ---- -title: OPEN_IMAGE -description: The OPEN_IMAGE node loads an image file from disk and returns an image type DataContainer object. -keywords: [Python, Extractor, Extract, Open image file node, Image file extraction, File manipulation tools, Flojoy Extractors documentation, Python image data extraction, Image file handling, Data extraction from images, Image processing with Flojoy, Image file opening in Python, Extracting image data] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load an image file from disk - - {App1} + GLink='EXTRACTORS/FILE/OPEN_IMAGE' + nodeLabel='OPEN_IMAGE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/EXTRACTORS/FILE/OPEN_IMAGE) diff --git a/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/OPEN_PARQUET.md b/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/OPEN_PARQUET.md index 83b5f4cd07..635f4dc8d9 100644 --- a/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/OPEN_PARQUET.md +++ b/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/OPEN_PARQUET.md @@ -1,13 +1,9 @@ ---- -title: OPEN_PARQUET -description: The OPEN_PARQUET node loads a local file of the .parquet file format. It returns the file in pandas.Dataframe type format. -keywords: [Python, Extractor, Extract, Open Parquet file node, Parquet file extraction, File manipulation tools, Flojoy Extractors documentation, Python Parquet data extraction, Parquet file handling, Data extraction from Parquet, Parquet processing with Flojoy, Parquet file opening in Python, Extracting Parquet data] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load a `.parquet` file from disk - - {App1} + GLink='EXTRACTORS/FILE/OPEN_PARQUET' + nodeLabel='OPEN_PARQUET'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/EXTRACTORS/FILE/OPEN_PARQUET) diff --git a/docs/nodes/EXTRACTORS/FILE/READ_CSV/READ_CSV.md b/docs/nodes/EXTRACTORS/FILE/READ_CSV/READ_CSV.md index 5e30e5e8cc..4c23a10878 100644 --- a/docs/nodes/EXTRACTORS/FILE/READ_CSV/READ_CSV.md +++ b/docs/nodes/EXTRACTORS/FILE/READ_CSV/READ_CSV.md @@ -1,13 +1,9 @@ ---- -title: READ_CSV -description: Efficiently read CSV files from local disk or URL using Python with Flojoy's READ_CSV node. Simplify data extraction and manipulation for enhanced analysis. -keywords: [Python, Extractor, Extract, CSV file reading, Python CSV extraction, Data extraction from CSV, Flojoy Read CSV node, Efficient data manipulation, CSV file handling, Python data extraction, Data analysis with CSV, CSV data processing, CSV data import in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/EXTRACTORS/FILE/READ_CSV/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load a `.csv` file from disk or a URL - - {App1} + GLink='EXTRACTORS/FILE/READ_CSV' + nodeLabel='READ_CSV'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/EXTRACTORS/FILE/READ_CSV) diff --git a/docs/nodes/EXTRACTORS/FILE/READ_S3/READ_S3.md b/docs/nodes/EXTRACTORS/FILE/READ_S3/READ_S3.md index 2ff8fc1410..77cea89a7b 100644 --- a/docs/nodes/EXTRACTORS/FILE/READ_S3/READ_S3.md +++ b/docs/nodes/EXTRACTORS/FILE/READ_S3/READ_S3.md @@ -1,13 +1,9 @@ ---- -title: READ_S3 -description: The READ_S3 node takes a S3_key name, S3 bucket name, and file name as input, and extracts the file from the specified bucket using the S3_key that was saved. -keywords: [Python, Extractor, Extract, AWS, S3 file reading, Read data from S3, File extraction from S3, Flojoy Read S3 node, Python S3 data retrieval, S3 file handling, Data extraction from cloud, Python data import from S3, Cloud data processing, Efficient data access from S3] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/EXTRACTORS/FILE/READ_S3/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Extract a file from an S3 bucket - - {App1} + GLink='EXTRACTORS/FILE/READ_S3' + nodeLabel='READ_S3'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/EXTRACTORS/FILE/READ_S3) diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/PLOTLY_DATASET.md b/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/PLOTLY_DATASET.md index b8ad77556d..fe1676b1ac 100644 --- a/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/PLOTLY_DATASET.md +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/PLOTLY_DATASET.md @@ -1,13 +1,9 @@ ---- -title: PLOTLY_DATASET -description: The PLOTLY_DATASET node retrieves a pandas DataFrame from a Plotly built-in dataset using the provided dataset_key parameter and returns it wrapped in a Flojoy DataFrame class. -keywords: [Python, Generate, Plotly, Plotly dataset generator, Sample datasets with Plotly, Flojoy generator nodes, Python Plotly data visualization, Plotly dataset examples, Interactive data plotting, Plotly data simulation, Python dataset generation, Plotly visualization tools, Data visualization using Plotly] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Retrieve a dataframe from a Plotly dataset - - {App1} + GLink='GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET' + nodeLabel='PLOTLY_DATASET'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SAMPLE_DATASETS/PLOTLY_DATASET) diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.md b/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.md index eaf9d31b7d..f057aaa236 100644 --- a/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.md +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/SCIKIT_LEARN_DATASET/SCIKIT_LEARN_DATASET.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### SCIKIT_LEARN_DATASET example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/TEXT_DATASET.md b/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/TEXT_DATASET.md index 9309198611..7715edfab7 100644 --- a/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/TEXT_DATASET.md +++ b/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/TEXT_DATASET.md @@ -1,13 +1,9 @@ ---- -title: TEXT_DATASET -description: The TEXT_DATASET node loads the 20 newsgroups dataset from scikit"-"learn. The data is returned as a dataframe with one column containing the text and the other containing the category. -keywords: [Python, Generate, Text dataset generator, Sample text datasets, Flojoy generator nodes, Synthetic text data, Text dataset examples, Text data simulation, Text dataset generation, Data simulation for NLP, Text data analysis tools, Text dataset for training] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Retrieve categorized text from a text dataset - - {App1} + GLink='GENERATORS/SAMPLE_DATASETS/TEXT_DATASET' + nodeLabel='TEXT_DATASET'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SAMPLE_DATASETS/TEXT_DATASET) diff --git a/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/SKIMAGE.md b/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/SKIMAGE.md index ca88ad4eb1..1a77b68387 100644 --- a/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/SKIMAGE.md +++ b/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE/SKIMAGE.md @@ -1,13 +1,9 @@ ---- -title: SKIMAGE -description: Explore Python-powered image data generation with Flojoy's SklearnImage generator nodes designed to load example images from scikit-image. -keywords: [Python, Generate, SklearnImage generator, Sample image data generation, Python image data simulation, Image dataset generation, Flojoy generator nodes, AI/ML image datasets, SklearnImage examples, Synthetic image data, Image data for training, Image data augmentation] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SAMPLE_DATASETS/SKIMAGE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,40 +12,28 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load `scikit` images - - {App1} + GLink='GENERATORS/SAMPLE_IMAGES/SKIMAGE' + nodeLabel='SKIMAGE'> - - - + [//]: # (Appendix) @@ -64,10 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SAMPLE_IMAGES/SKIMAGE) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/BASIC_OSCILLATOR.md b/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/BASIC_OSCILLATOR.md index 97b4bc417f..c3b9abdae7 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/BASIC_OSCILLATOR.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/BASIC_OSCILLATOR.md @@ -1,13 +1,9 @@ ---- -title: BASIC_OSCILLATOR -description: A straightforward way to generate signals, with sample rate and the time in seconds as parameters. Particularly useful with signal processing applications, as the sample rate is commonly used. -keywords: [Python, Python-based simulations, Basic oscillator generator, Dynamic analysis techniques, Oscillator modeling, Simulation documentation, Simulation tools, Python oscillator examples, Oscillation simulations, Interactive oscillator models] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a sine wave - - {App1} + GLink='GENERATORS/SIMULATIONS/BASIC_OSCILLATOR' + nodeLabel='BASIC_OSCILLATOR'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/BASIC_OSCILLATOR) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/CONSTANT.md b/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/CONSTANT.md index eb59751cd3..7e4b3585cd 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/CONSTANT.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/CONSTANT.md @@ -1,13 +1,9 @@ ---- -title: CONSTANT -description: Easily create constant value simulations using Python and Flojoy's CONSTANT generator node. It generates a single x-y vector of numeric (floating point) constants. -keywords: [Python, Simulations, Value Generator, Python-based simulations, Python constant value generator, Constant simulations in Python, Python simulation tools, Constant value modeling, Python simulation examples, Simulation documentation, Constant value generation, Python simulation techniques, Constant value modeling] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate an OrderedPair, Vector or Scalar of numeric constants - - {App1} + GLink='GENERATORS/SIMULATIONS/CONSTANT' + nodeLabel='CONSTANT'> - + - + [//]: # (Appendix) -## Appendix - import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/CONSTANT) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/FEEDBACK.md b/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/FEEDBACK.md index da0b06e14a..7eaeb50210 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/FEEDBACK.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/FEEDBACK.md @@ -1,14 +1,9 @@ ---- -title: FEEDBACK -description: Discover Python-based feedback simulations with Flojoy's FEEDBACK node. It captures the result of the specified node ID. If the result is not found, it passes the result of the parent node. -keywords: [Python, Simulations, Python feedback simulations, Feedback loop, -Feedback systems in Python, Flojoy generator nodes, Python simulation tools, Feedback modeling examples, Dynamic feedback simulations, Python simulation, Feedback loop generation, Python simulation techniques, Dynamic system modeling in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -17,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Capture and pass results from specific nodes - - {App1} + GLink='GENERATORS/SIMULATIONS/FEEDBACK' + nodeLabel='FEEDBACK'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/FEEDBACK) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/LINSPACE.md b/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/LINSPACE.md index 06352dcd3d..8a0184fc53 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/LINSPACE.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/LINSPACE.md @@ -1,13 +1,9 @@ ---- -title: LINSPACE -description: In this example, the Python-based LINSPACE node generates an OrderedPair, which is visualized with the SCATTER node. -keywords: [Python, Simulations] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate data spaced evenly between two points - - {App1} + GLink='GENERATORS/SIMULATIONS/LINSPACE' + nodeLabel='LINSPACE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/LINSPACE) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/MATRIX.md b/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/MATRIX.md index b03cd6fefe..2026839c2a 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/MATRIX.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/MATRIX.md @@ -1,13 +1,9 @@ ---- -title: MATRIX -description: Master random matrix simulations with Python using the MATRIX generator node from Flojoy. The MATRIX node takes row and col arguments as input and generates a random matrix where the integers inside the matrix are between 0 and 19. -keywords: [Python, Simulations, Python Matrix simulations, Matrix manipulation techniques, Flojoy generator nodes, Dynamic matrix modeling, Matrix simulation examples, Python simulation tools, Matrix manipulation in Python, Matrix-based simulations, Dynamic system modeling, Python matrix generator, Random matrix generator] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/MATRIX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a random matrix - - {App1} + GLink='GENERATORS/SIMULATIONS/MATRIX' + nodeLabel='MATRIX'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/MATRIX) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/POPULATE.md b/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/POPULATE.md index 3d0ec4fa23..e790bdd5c5 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/POPULATE.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/POPULATE/POPULATE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### POPULATE example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/RAND/RAND.md b/docs/nodes/GENERATORS/SIMULATIONS/RAND/RAND.md index 41b8c73b57..d6c88a9c1d 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/RAND/RAND.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/RAND/RAND.md @@ -1,13 +1,9 @@ ---- -title: RAND -description: The RAND node generates a random number or a list of random numbers depending on the distribution selected. Master Python-powered random simulations with Flojoy's RAND node for seamless and efficient random simulations. -keywords: [Python, Simulations, Value Generator, Python-based simulations, Python random simulations, Flojoy generator nodes, Dynamic modeling techniques, Random simulation examples, Python simulation tools, Random number generator, Dynamic system modeling, Random data generation, Python simulation documentation, Random list generator, Random simulation in Flojoy] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/RAND/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a single or list of random numbers - - {App1} + GLink='GENERATORS/SIMULATIONS/RAND' + nodeLabel='RAND'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/RAND) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/SCALAR.md b/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/SCALAR.md index 959aa4c574..cf6025a474 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/SCALAR.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/SCALAR/SCALAR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a single Scalar value - - {App1} + GLink='GENERATORS/SIMULATIONS/SCALAR' + nodeLabel='SCALAR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/SECOND_ORDER_SYSTEM.md b/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/SECOND_ORDER_SYSTEM.md index bed861ab54..60cc570bdd 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/SECOND_ORDER_SYSTEM.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/SECOND_ORDER_SYSTEM.md @@ -1,13 +1,9 @@ ---- -title: SECOND_ORDER_SYSTEM -description: The SECOND_ORDER_SYSTEM has a second order exponential function. This node is designed to be used in a Python loop. The data is appended as the loop progresses and written to memory. -keywords: [Python, Simulations, Python second order system simulations, Exponential function, Second-order system analysis, Flojoy generator nodes, Python simulation tools, System simulation examples, Dynamic system design, Python simulation documentation, Second-order system modeling, Dynamic system analysis in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply a second order exponential function - - {App1} + GLink='GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM' + nodeLabel='SECOND_ORDER_SYSTEM'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/SECOND_ORDER_SYSTEM) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/SINE/SINE.md b/docs/nodes/GENERATORS/SIMULATIONS/SINE/SINE.md index 2183436410..257f52ec37 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/SINE/SINE.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/SINE/SINE.md @@ -1,13 +1,9 @@ ---- -title: SINE -description: In this example, the LINSPACE and SINE nodes generate a sine function which is visualized with the SCATTER node. -keywords: [Python, Simulations] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/SINE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a waveform function - - {App1} + GLink='GENERATORS/SIMULATIONS/SINE' + nodeLabel='SINE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/SINE) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/TEXT/TEXT.md b/docs/nodes/GENERATORS/SIMULATIONS/TEXT/TEXT.md index 07379f381b..ce4df45000 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/TEXT/TEXT.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/TEXT/TEXT.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} - + + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a TextBlob - - {App1} + GLink='GENERATORS/SIMULATIONS/TEXT' + nodeLabel='TEXT'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/TIMESERIES.md b/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/TIMESERIES.md index 85529425e0..2a185d59b0 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/TIMESERIES.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/TIMESERIES.md @@ -1,13 +1,9 @@ ---- -title: TIMESERIES -description: Discover Python-powered time series simulations with Flojoy's TIMESERIES node. The TIMESERIES node generates a random timeseries vector. -keywords: [Python, Simulation, Python time series simulations, Dynamic time series modeling, Time series forecasting, Flojoy generator nodes, Python simulation tools, Time series analysis techniques, Time series simulation examples, Python simulation documentation, Dynamic data analysis, Time series modeling in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate random timeseries data - - {App1} + GLink='GENERATORS/SIMULATIONS/TIMESERIES' + nodeLabel='TIMESERIES'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/TIMESERIES) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/UNIX_TIMESTAMP.md b/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/UNIX_TIMESTAMP.md index 76d288296c..685f7ba142 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/UNIX_TIMESTAMP.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP/UNIX_TIMESTAMP.md @@ -1,11 +1,9 @@ ---- -title: Unix timestamps in Flojoy -description: A Flojoy node that generates a timestamp for the current time. ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -14,39 +12,31 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Generate a real-time timestamp for a measurement value - - {App1} + GLink='GENERATORS/SIMULATIONS/UNIX_TIMESTAMP' + nodeLabel='UNIX_TIMESTAMP'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -58,10 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/UNIX_TIMESTAMP) diff --git a/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/WAVEPACKET.md b/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/WAVEPACKET.md index e12804d86f..702bf5cf1e 100644 --- a/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/WAVEPACKET.md +++ b/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET/WAVEPACKET.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Simulate the behavior of a wavepacket in a box - - {App1} + GLink='GENERATORS/SIMULATIONS/WAVEPACKET' + nodeLabel='WAVEPACKET'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/GENERATORS/SIMULATIONS/WAVEPACKET) diff --git a/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/FLEXIFORCE_25LB.md b/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/FLEXIFORCE_25LB.md index ad8a5812b5..2368c3a4ed 100644 --- a/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/FLEXIFORCE_25LB.md +++ b/docs/nodes/IO/ANALOG_SENSORS/PRESSURE_SENSORS/FLEXIFORCE_25LB/FLEXIFORCE_25LB.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Convert voltages into pressures - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34.md b/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34.md index d53f177c92..6267b5c9f3 100644 --- a/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34.md +++ b/docs/nodes/IO/ANALOG_SENSORS/THERMOCOUPLES/LM34/LM34.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,33 +12,29 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Convert voltages into temperatures - - - {App1} + - + - + [//]: # (Appendix) @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/IMAGING/OPEN_WEBCAM/OPEN_WEBCAM.md b/docs/nodes/IO/IMAGING/OPEN_WEBCAM/OPEN_WEBCAM.md index 47898bf6a2..cdda4438ad 100644 --- a/docs/nodes/IO/IMAGING/OPEN_WEBCAM/OPEN_WEBCAM.md +++ b/docs/nodes/IO/IMAGING/OPEN_WEBCAM/OPEN_WEBCAM.md @@ -1,13 +1,9 @@ ---- -title: OPEN_WEBCAM -description: In this example, the OPEN_WEBCAM opens the connection with the connected camera, then uses the `WEBCAM` node takes and returns a picture. The IMSHOW node then displays the image taken by the camera. -keyword: [Python, Instrument, Web cam, Camera, Python webcam integration, Camera instrument in Python, Capture images and videos, Streamline webcam usage, Python-based camera control, Webcam integration techniques, Python image and video capture, Enhance projects with webcam, Accurate media processing, Webcam usage with Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/WEB_CAM/CAMERA/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -29,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### OPEN_WEBCAM example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/IMAGING/WEBCAM/WEBCAM.md b/docs/nodes/IO/IMAGING/WEBCAM/WEBCAM.md index 3946121b3a..2d4a654855 100644 --- a/docs/nodes/IO/IMAGING/WEBCAM/WEBCAM.md +++ b/docs/nodes/IO/IMAGING/WEBCAM/WEBCAM.md @@ -1,29 +1,9 @@ ---- -title: WEBCAM -description: In this example, the WEBCAM node takes and returns a picture if a USB camera is connected to the computer. The IMSHOW node then displays the image taken by the camera. -keyword: - [ - Python, - Instrument, - Web cam, - Camera, - Python webcam integration, - Camera instrument in Python, - Capture images and videos, - Streamline webcam usage, - Python-based camera control, - Webcam integration techniques, - Python image and video capture, - Enhance projects with webcam, - Accurate media processing, - Webcam usage with Python, - ] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/WEB_CAM/CAMERA/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -32,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -45,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### WEBCAM example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/ATTENUATION_LDA602.md b/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/ATTENUATION_LDA602.md index aec6cc1a15..98aa11459a 100644 --- a/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/ATTENUATION_LDA602.md +++ b/docs/nodes/IO/INSTRUMENTS/ATTENUATORS/LDA/LDA602/ATTENUATION_LDA602/ATTENUATION_LDA602.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### ATTENUATION_LDA602 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/READ_A0_PINS.md b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/READ_A0_PINS.md index 33d2429f65..297b52e905 100644 --- a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/READ_A0_PINS.md +++ b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/LABJACK/U3/BASIC/READ_A0_PINS/READ_A0_PINS.md @@ -1,13 +1,9 @@ ---- -title: LABJACKU3 -description: In this example, we show how to record and display temperature measurements with a LABJACK U3 device and update them in a Loop. -keyword: [Python, Instrument, LabJack U3 instrument control, Python integration with LabJack, Measurement and analysis, Python-based instrument control, LabJack U3 integration techniques, Python-based measurement techniques, Enhance measurements with Python, Streamline LabJack usage, Accurate data analysis, Python control of LabJack U3] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/LABJACK/LABJACKU3/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Record and display temperature measurements - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/READ_N_PINS.md b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/READ_N_PINS.md index cc1cca424d..7f343dd9cc 100644 --- a/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/READ_N_PINS.md +++ b/docs/nodes/IO/INSTRUMENTS/DAQ_BOARDS/PHIDGET/INTERFACEKIT/BASIC/READ_N_PINS/READ_N_PINS.md @@ -1,13 +1,9 @@ ---- -title: PHIDGET22 -description: This example shows how to use the PHIDGET22 node to measure pressures from Flexiforce sensors using a Phidget Interface Kit. -keyword: [Python, Instrument, Phidget22 instrument control, Python integration with Phidget, Measurement and analysis, Python-based instrument control, Phidget22 integration techniques, Python-based measurement techniques, Enhance measurements with Python, Streamline Phidget usage, Accurate data analysis, Python control of Phidget22] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/PHIDGET/PHIDGET22/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Measure pressures from Flexiforce sensors - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/BURST_MODE_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/BURST_MODE_33510B.md index d132b7adb5..02a991d78e 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/BURST_MODE_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B/BURST_MODE_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator Burst Mode -description: The BURST_MODE_33510B node is used to turn the Burst mode on or off. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### BURST_MODE_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/BURST_MODE_33510B' + nodeLabel='BURST_MODE_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/RETURN_ERRORS_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/RETURN_ERRORS_33510B.md index bb5b9bbb8d..ae4ff38456 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/RETURN_ERRORS_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B/RETURN_ERRORS_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator Return Errors -description: The RETURN_ERRORS_33510B node returns error messages from the WFG. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### RETURN_ERRORS_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/ADVANCED/RETURN_ERRORS_33510B' + nodeLabel='RETURN_ERRORS_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/CONNECTION_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/CONNECTION_33510B.md index ecca6f9b83..7536572360 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/CONNECTION_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B/CONNECTION_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator Connection -description: The CONNECTIONS_33510B node is used to connect to a 33510B WFG. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### CONNECTION_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/CONNECTION_33510B' + nodeLabel='CONNECTION_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/ON_OFF_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/ON_OFF_33510B.md index 75cb9cc1fe..8f36092562 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/ON_OFF_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B/ON_OFF_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator On Off -description: The ON_OFF_33510B node is used to turn the output on or off. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### ON_OFF_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/ON_OFF_33510B' + nodeLabel='ON_OFF_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B.md index 05a13d980d..62ac790013 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B/OUTPUT_SYNC_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator Output Sync -description: The OUTPUT_SYNC_33510B node is used sync multiple outputs phases. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### OUTPUT_SYNC_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/OUTPUT_SYNC_33510B' + nodeLabel='OUTPUT_SYNC_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/SET_WAVEFORM_33510B.md b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/SET_WAVEFORM_33510B.md index 0d5901da84..7c38430864 100644 --- a/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/SET_WAVEFORM_33510B.md +++ b/docs/nodes/IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B/SET_WAVEFORM_33510B.md @@ -1,12 +1,9 @@ ---- -title: Waveform Generator Set Waveform -description: The SET_WAVEFORM_33510B node is used to set waveform settings for a 33510B. -keywords: [Python, Instrument Control, Keysight, Wavefunction Generator, Function Generator, Keysight 33500B] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -15,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -28,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### SET_WAVEFORM_33510B example - - {App1} + GLink='IO/INSTRUMENTS/FUNCTION_GENERATORS/KEYSIGHT/33XXX/BASIC/SET_WAVEFORM_33510B' + nodeLabel='SET_WAVEFORM_33510B'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/WEINSCHEL8320.md b/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/WEINSCHEL8320.md index 4aafe3aeb2..531f17e0ba 100644 --- a/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/WEINSCHEL8320.md +++ b/docs/nodes/IO/INSTRUMENTS/MOCK/WEINSCHEL8320/WEINSCHEL8320.md @@ -1,27 +1,9 @@ ---- -title: WEINSCHEL8320 -description: In this example, we mock a Weinschel 8320 -keyword: - [ - Python, - Instrument, - Weinschel 8320, - Weinschel 8320 control, - Python instrument integration, - Measurement and analysis, - Python"-"based instrument control, - Keithley instrument control, - Enhance measurements with Python, - Python"-"based measurement techniques, - Streamline instrument usage, - Accurate data analysis, - Python integration with Weinschel 8320, - ] ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -30,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Simulate a Weinschel 8320 attenuator - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -70,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/AC_CURRENT_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/AC_CURRENT_USB4065.md index 26325e286d..6f11ac3bf5 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/AC_CURRENT_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_CURRENT_USB4065/AC_CURRENT_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### AC_CURRENT_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065.md index 791c076c1a..4343b8ae80 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/AC_VOLTAGE_USB4065/AC_VOLTAGE_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### AC_VOLTAGE_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/CONNECTION_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/CONNECTION_USB4065.md index b82d3f2619..e9cc8fa14c 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/CONNECTION_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/CONNECTION_USB4065/CONNECTION_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### CONNECTION_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/DC_CURRENT_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/DC_CURRENT_USB4065.md index c11e0ecc4a..c9e030a7b1 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/DC_CURRENT_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_CURRENT_USB4065/DC_CURRENT_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### DC_CURRENT_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065.md index f0dd9bb0c7..33b575a518 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DC_VOLTAGE_USB4065/DC_VOLTAGE_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### DC_VOLTAGE_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/DIODE_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/DIODE_USB4065.md index 44507e920a..2ef7425ea7 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/DIODE_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/DIODE_USB4065/DIODE_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### DIODE_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/RESISTANCE_USB4065.md b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/RESISTANCE_USB4065.md index 833eba1169..378108c2c6 100644 --- a/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/RESISTANCE_USB4065.md +++ b/docs/nodes/IO/INSTRUMENTS/MULTIMETERS/NI/USB_4065/BASIC/RESISTANCE_USB4065/RESISTANCE_USB4065.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### RESISTANCE_USB4065 example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/ADVANCED_MEASUREMENTS_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/ADVANCED_MEASUREMENTS_MDO3XXX.md index 24807098a5..a1ca19d555 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/ADVANCED_MEASUREMENTS_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/ADVANCED_MEASUREMENTS_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: ADVANCED_MEASUREMENTS_MDO3XXX -description: The ADVANCED_MEASUREMENTS_MDO3XXX node can extract many trace measurements from the MDO3000 series oscilloscopes. -keywords: [oscilloscope, python, extract, control, instrument, measurement, rise time] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Extract waveform measurements from an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/ADVANCED_MEASUREMENTS_MDO3XXX' + nodeLabel='ADVANCED_MEASUREMENTS_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/TRIGGER_SETTINGS_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/TRIGGER_SETTINGS_MDO3XXX.md index d72fe2c26f..69fc8e28e5 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/TRIGGER_SETTINGS_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/TRIGGER_SETTINGS_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: TRIGGER_SETTINGS_MDO3XXX -description: The TRIGGER_SETTINGS_MDO3XXX node can extract many trace measurements from the MDO3000 series oscilloscopes. -keywords: [oscilloscope, python, extract, control, instrument, triggering] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Set the triggering channel for an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/ADVANCED/TRIGGER_SETTINGS_MDO3XXX' + nodeLabel='TRIGGER_SETTINGS_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/CONNECTION_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/CONNECTION_MDO3XXX.md index a3a554d48f..3e1826bc4d 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/CONNECTION_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/CONNECTION_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: CONNECTION_MDO3XXX -description: The CONNECTION_MDO3XXX node extracts the phase measurement between two traces from a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, phase] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -29,25 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### CONNECTION_MDO3XXX example - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/CONNECTION_MDO3XXX' + nodeLabel='CONNECTION_MDO3XXX'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/EXTRACT_TRACE_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/EXTRACT_TRACE_MDO3XXX.md index e63d2edf82..2ca5c074ff 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/EXTRACT_TRACE_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/EXTRACT_TRACE_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: EXTRACT_TRACE_MDO3XXX -description: The EXTRACT_TRACE_MDO3XXX node extracts the phase measurement between two traces from a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, trace] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Extract signal traces from an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/EXTRACT_TRACE_MDO3XXX' + nodeLabel='EXTRACT_TRACE_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/MEASUREMENTS_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/MEASUREMENTS_MDO3XXX.md index 0e260ecec2..99f69f9bf8 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/MEASUREMENTS_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/MEASUREMENTS_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: MEASUREMENTS_MDO3XXX -description: The MEASUREMENTS_MDO3XXX node extracts various trace measurements from a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, phase] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Extract simple waveform measurements from an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASUREMENTS_MDO3XXX' + nodeLabel='MEASUREMENTS_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/MEASURE_PHASE_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/MEASURE_PHASE_MDO3XXX.md index 15e1d6cee7..5a35efb5aa 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/MEASURE_PHASE_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/MEASURE_PHASE_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: MEASURE_PHASE_MDO3XXX -description: The MEASURE_PHASE_MDO3XXX node extracts the phase measurement between two traces from a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, phase] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Measure the phase difference between two channels of an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/MEASURE_PHASE_MDO3XXX' + nodeLabel='MEASURE_PHASE_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/TERMINATION_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/TERMINATION_MDO3XXX.md index 1c6c4741ac..6c3e12ac11 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/TERMINATION_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/TERMINATION_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: TERMINATION_MDO3XXX -description: The TERMINATION_MDO3XXX node sets the termination value for a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, termination] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,35 +12,29 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Set or query the termination value for an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TERMINATION_MDO3XXX' + nodeLabel='TERMINATION_MDO3XXX'> - + - + [//]: # (Appendix) @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/TRIGGER_CHANNEL_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/TRIGGER_CHANNEL_MDO3XXX.md index 6edc1ef568..bd4212e52c 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/TRIGGER_CHANNEL_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/TRIGGER_CHANNEL_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: TRIGGER_CHANNEL_MDO3XXX -description: The TRIGGER_CHANNEL_MDO3XXX node sets the triggering channel for a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, trigger] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Set the triggering channel for an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_CHANNEL_MDO3XXX' + nodeLabel='TRIGGER_CHANNEL_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/TRIGGER_LEVEL_MDO3XXX.md b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/TRIGGER_LEVEL_MDO3XXX.md index 009d732b8f..f40500ba47 100644 --- a/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/TRIGGER_LEVEL_MDO3XXX.md +++ b/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/TRIGGER_LEVEL_MDO3XXX.md @@ -1,13 +1,9 @@ ---- -title: TRIGGER_LEVEL_MDO3XXX -description: The TRIGGER_LEVEL_MDO3XXX node sets the triggering voltage for a MDO3XXX oscilloscope. -keywords: [oscilloscope, python, extract, control, instrument, trigger] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Set the trigger voltage for an oscilloscope - - {App1} + GLink='IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX' + nodeLabel='TRIGGER_LEVEL_MDO3XXX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -58,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/CLOSE_ALL.md b/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/CLOSE_ALL.md index 1cfc172e0b..6011d7ce24 100644 --- a/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/CLOSE_ALL.md +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/CLOSE_ALL/CLOSE_ALL.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,33 +12,29 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Close all QCoDeS instruments - - - {App1} + - + - + [//]: # (Appendix) @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/LIST_VISA.md b/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/LIST_VISA.md index 46425f013a..72d3d78e82 100644 --- a/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/LIST_VISA.md +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/LIST_VISA/LIST_VISA.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### List VISA instruments - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/VISA_IDENTITY.md b/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/VISA_IDENTITY.md index ef8a4d2a1a..d525a1b456 100644 --- a/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/VISA_IDENTITY.md +++ b/docs/nodes/IO/INSTRUMENTS/QCODES/VISA_IDENTITY/VISA_IDENTITY.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Send an identity query to an instrument - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/IV_SWEEP.md b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/IV_SWEEP.md index 389689cc6f..e63e5d63d0 100644 --- a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/IV_SWEEP.md +++ b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/IV_SWEEP/IV_SWEEP.md @@ -1,13 +1,9 @@ ---- -title: KEITHLEY2400 -description: In this example, we demonstrate how to record an I"-"V curve using Flojoy, a Keithley 2400 source meter, and a computer. -keyword: [Python, Instrument, Keithley 2400 control, Python instrument integration, Measurement and analysis, Python"-"based instrument control, Keithley instrument control, Enhance measurements with Python, Python"-"based measurement techniques, Streamline instrument usage, Accurate data analysis,Python integration with Keithley 2400] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/KEITHLEY/KEITHLEY2/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Record an I-V curve - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/OPEN_KEITHLEY_24XX.md b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/OPEN_KEITHLEY_24XX.md index 17adee86c3..f5bd710f01 100644 --- a/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/OPEN_KEITHLEY_24XX.md +++ b/docs/nodes/IO/INSTRUMENTS/SOURCEMETERS/KEITHLEY/24XX/BASIC/OPEN_KEITHLEY_24XX/OPEN_KEITHLEY_24XX.md @@ -1,13 +1,9 @@ ---- -title: OPEN_KEITHLEY_24XX -description: In this example, we demonstrate how to record an I"-"V curve using Flojoy, a Keithley 2400 source meter, and a computer. -keyword: [Python, Instrument, Keithley 2400 control, Python instrument integration, Measurement and analysis, Python"-"based instrument control, Keithley instrument control, Enhance measurements with Python, Python"-"based measurement techniques, Streamline instrument usage, Accurate data analysis,Python integration with Keithley 2400] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/KEITHLEY/KEITHLEY2/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -29,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### OPEN_KEITHLEY_24XX example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/TIC.md b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/TIC.md index a5bf56369c..20f9cf4c4a 100644 --- a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/TIC.md +++ b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC/TIC.md @@ -1,13 +1,9 @@ ---- -title: STEPPER_DRIVER_TIC -description: This node controls a stepper motor movement with a TIC driver. The user defines the speed and the sleep time between movements. -keyword: [Python, Instrument, Stepper motor control, Python integration with stepper driver, Motion control and automation, Python"-"based stepper motor control, Stepper motor driver integration, Accurate motor movement with Python, Enhance motion control with Python, Streamline motor automation, Precise motor control using Python, Python control of stepper driver TIC] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/STEPPER_MOTOR/STEPPER_DRIVER_TIC/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Control a stepper motor's movement - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/TIC_KNOB.md b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/TIC_KNOB.md index 88b59a9160..a855c48496 100644 --- a/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/TIC_KNOB.md +++ b/docs/nodes/IO/MOTION/MOTOR_DRIVER/STEPPER/POLULU/TIC_KNOB/TIC_KNOB.md @@ -1,13 +1,9 @@ ---- -title: STEPPER_DRIVER_TIC_KNOB -description: In this example, the STEPPER_DRIVER_TIC_KNOB node controls a stepper motor movement with a TIC driver. It allows you to control the motor's rotation with a KNOB button. From 0 to 100 corresponds to a rotation between 0 and 360 degrees. -keyword: [Python, Instrument, Stepper motor control with knob, Python integration with stepper driver, Motion control and automation, Python"-"based stepper motor control, Stepper motor driver integration, Accurate motor movement with Python, Enhance motion control with knob, Streamline motor automation, Precise motor control using Python, Python control of stepper driver TIC with knob] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/STEPPER_MOTOR/STEPPER_DRIVER_TIC_KNOB/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,34 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### Control a stepper motor's rotation - - - {App1} + - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/IO/PROTOCOLS/SCPI/IDN/IDN.md b/docs/nodes/IO/PROTOCOLS/SCPI/IDN/IDN.md index 39bcfc4519..e2d65e3a8d 100644 --- a/docs/nodes/IO/PROTOCOLS/SCPI/IDN/IDN.md +++ b/docs/nodes/IO/PROTOCOLS/SCPI/IDN/IDN.md @@ -1,11 +1,9 @@ ---- -title: IDN -description: Query the identity of a connected device through the IDN? SCPI command. ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -14,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Send the IDN? SCPI query command - - {App1} + GLink='IO/PROTOCOLS/SCPI/IDN' + nodeLabel='IDN'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - + diff --git a/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE.md b/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE.md index 3982a4925a..e1e2c60ac6 100644 --- a/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE.md +++ b/docs/nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE.md @@ -1,11 +1,9 @@ ---- -title: MEASURE_VOLTAGE -description: Read a voltage from a connected device that supports the SCPI protocol. ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -14,36 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Send the MEASURE:VOLTAGE:DC command - - {App1} + GLink='IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE' + nodeLabel='MEASURE_VOLTAGE'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -56,4 +48,4 @@ import Media from './appendix/media.md'; - + diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL.md b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL.md index e0d74f364d..451ee958fd 100644 --- a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL.md +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### OPEN_SERIAL example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/SERIAL_SINGLE_MEASUREMENT.md b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/SERIAL_SINGLE_MEASUREMENT.md index 8d5b2b33b9..8bbf5821d3 100644 --- a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/SERIAL_SINGLE_MEASUREMENT.md +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_SINGLE_MEASUREMENT/SERIAL_SINGLE_MEASUREMENT.md @@ -1,13 +1,9 @@ ---- -title: SERIAL_SINGLE_MEASUREMENT -description: In this example, we use the SERIAL_SINGLE_MEASUREMENT node to extract some measurements received from an Arduino microcontroller and visualize the output. -keyword: [Python, Instrument, Serial communication measurement, Python serial instrument integration, Data acquisition and analysis, Python"-"based serial measurement, Serial instrument integration techniques, Accurate measurement with Python, Enhance measurement with serial communication, Streamline data acquisition, Precise measurement using Python, Python control of serial single measurement] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/SERIAL/SERIAL_SINGLE_MEASUREMENT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -29,22 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### SERIAL_SINGLE_MEASUREMENT example - - - {App1} + - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/SERIAL_TIMESERIES.md b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/SERIAL_TIMESERIES.md index 40f2d57aa9..a1479c4336 100644 --- a/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/SERIAL_TIMESERIES.md +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/BASIC/SERIAL_TIMESERIES/SERIAL_TIMESERIES.md @@ -1,13 +1,9 @@ ---- -title: SERIAL_TIMESERIES -description: In this example, we use the SERIAL_TIMESERIES node to extract some time-dependent measurements received from an Arduino microcontroller and visualize the output. -keyword: [Python, Instrument, Serial communication timeseries, Python serial data acquisition, Time"-"series data analysis, Python-based serial data collection, Serial data acquisition techniques, Accurate timeseries recording with Python, Enhance data analysis with serial communication, Streamline timeseries data acquisition, Precise data collection using Python, Python control of serial timeseries data] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/INSTRUMENTS/SERIAL/SERIAL_TIMESERIES/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -29,22 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### SERIAL_TIMESERIES example - - - {App1} + - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/ACTIVATE.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/ACTIVATE.md index 8568d64d50..122fd6b232 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/ACTIVATE.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/ACTIVATE/ACTIVATE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### ACTIVATE example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/CONNECT.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/CONNECT.md index 37729a7d3a..614e2b1cf5 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/CONNECT.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/CONNECT/CONNECT.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### CONNECT example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/DELAY.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/DELAY.md index 2d4d86dce8..98267f6b18 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/DELAY.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DELAY/DELAY.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### DELAY example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/DISCONNECT.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/DISCONNECT.md index fed6aafc97..04f8be4ece 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/DISCONNECT.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/DISCONNECT/DISCONNECT.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### DISCONNECT example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/HOME.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/HOME.md index d73026c052..0346485196 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/HOME.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/HOME/HOME.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### HOME example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/MOVE_JOINT.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/MOVE_JOINT.md index 3fb320fdd6..804cd08f89 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/MOVE_JOINT.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_JOINT/MOVE_JOINT.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### MOVE_JOINT example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/MOVE_LIN.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/MOVE_LIN.md index f0c3d372af..34e8384a9b 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/MOVE_LIN.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_LIN/MOVE_LIN.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### MOVE_LIN example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/MOVE_POSE.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/MOVE_POSE.md index dd56ca1c77..2e32e61adf 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/MOVE_POSE.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/MOVE_POSE/MOVE_POSE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### MOVE_POSE example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/SET_CART_LIN_VEL.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/SET_CART_LIN_VEL.md index e04a6c6f11..6cadcb9112 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/SET_CART_LIN_VEL.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_CART_LIN_VEL/SET_CART_LIN_VEL.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### SET_CART_LIN_VEL example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/SET_JOINT_VEL.md b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/SET_JOINT_VEL.md index 3207f8c1eb..c6e962b90d 100644 --- a/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/SET_JOINT_VEL.md +++ b/docs/nodes/IO/ROBOTICS/ARMS/MECADEMIC/SET_JOINT_VEL/SET_JOINT_VEL.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,23 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; - -### SET_JOINT_VEL example - - - {App1} + - - - + [//]: # (Appendix) diff --git a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/FLOJOY_CLOUD_DOWNLOAD.md b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/FLOJOY_CLOUD_DOWNLOAD.md index 12960eb002..a214e992e6 100644 --- a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/FLOJOY_CLOUD_DOWNLOAD.md +++ b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_DOWNLOAD/FLOJOY_CLOUD_DOWNLOAD.md @@ -1,45 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; +[//]: # (Examples) -### Download a DataContainer from Flojoy Cloud +## Examples - - {App1} + - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/FLOJOY_CLOUD_UPLOAD.md b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/FLOJOY_CLOUD_UPLOAD.md index 8d546cd4c5..de04c0a035 100644 --- a/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/FLOJOY_CLOUD_UPLOAD.md +++ b/docs/nodes/LOADERS/CLOUD_DATABASE/FLOJOY_CLOUD_UPLOAD/FLOJOY_CLOUD_UPLOAD.md @@ -1,45 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; +[//]: # (Examples) -### Upload a DataContainer to Flojoy Cloud +## Examples - - {App1} + - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -51,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/DS_LOAD.md b/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/DS_LOAD.md index cd39316c08..7ff8714ee4 100644 --- a/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/DS_LOAD.md +++ b/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD/DS_LOAD.md @@ -1,15 +1,10 @@ ---- -title: DS_LOAD -description: Efficiently load datasets into Python using Flojoy's DS_LOAD node. It loads data directly from in-memory data storage. -keyword: [Python, Load, Dataset loading in Python, Efficient data retrieval, Flojoy DS_LOAD node, Internal memory data loading, Python data analysis tools, Streamline data loading, Simplify data retrieval, Internal memory data access, Data processing with Flojoy, Dataset loading for analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/LOADERS/INTERNAL_MEMORY/DS_LOAD/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,19 +12,21 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -### Load data from in-memory data storage - @@ -37,6 +34,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -49,11 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOADERS/INTERNAL_MEMORY/DS_LOAD) diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/BATCH_PROCESSOR.md b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/BATCH_PROCESSOR.md index 6629e30acf..d57043f8d5 100644 --- a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/BATCH_PROCESSOR.md +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/BATCH_PROCESSOR.md @@ -1,57 +1,42 @@ ---- -title: BATCH_PROCESSOR -description: In this example, we demonstrate how to batch load many TIF images from within a directory, and process them each sequentially. The example processing here is to pass the loaded grayscale images as DataContainers to visualize with the IMAGE node. -keywords: [Python, Batch Processing, Iteration] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR/examples/EX1/app.jpeg ---- -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -import LoomEmbedder from '@site/src/components/LoomEmbedder'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### Batch load TIFF images from disk +## Examples - {App1} + GLink='LOADERS/LOCAL_FILE_SYSTEM/BATCH_PROCESSOR' + nodeLabel='BATCH_PROCESSOR'> - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -59,8 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - + + + - - diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/LOCAL_FILE.md b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/LOCAL_FILE.md index befa0f8aec..346f60b7d6 100644 --- a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/LOCAL_FILE.md +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/LOCAL_FILE.md @@ -1,13 +1,9 @@ ---- -title: LOCAL_FILE -description: The LOCAL_FILE node loads a local file of different format and converts it to a DataContainer class. -keyword: [Python, Extractor, Extract, Local file loading, Load data from local files, Data loading from file system, Flojoy Local File Loader, Python local file handling, Data import from local storage, Local data processing, Python file system loader, Efficient data access, Data loading with Flojoy] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load and convert a local file to a DataContainer - - {App1} + GLink='LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE' + nodeLabel='LOCAL_FILE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE) diff --git a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/OPEN_MATLAB.md b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/OPEN_MATLAB.md index 7e9ce72d14..5c7928fb92 100644 --- a/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/OPEN_MATLAB.md +++ b/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB/OPEN_MATLAB.md @@ -1,13 +1,9 @@ ---- -title: OPEN_MATLAB -description: The OPEN_MATLAB node loads a local file of the .mat file format. Note that if multiple tabs of data are used, the number of rows must match in order to stack the arrays. -keyword: [Python, Extractor, Extract, MATLAB, Open MATLAB file node, Load data from MATLAB files, MATLAB data loading, Flojoy Local File Loaders, Python MATLAB file handling, Data import from MATLAB, Local data processing with MATLAB, Python MATLAB loader, Efficient MATLAB data access, Data loading with Flojoy] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/LOCAL_FILE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load a local `.mat` file - - {App1} + GLink='LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB' + nodeLabel='OPEN_MATLAB'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOADERS/LOCAL_FILE_SYSTEM/OPEN_MATLAB) diff --git a/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/REMOTE_FILE.md b/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/REMOTE_FILE.md index 47c592f852..8e44f67373 100644 --- a/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/REMOTE_FILE.md +++ b/docs/nodes/LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE/REMOTE_FILE.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Load and convert a remote file to a DataContainer - - {App1} + GLink='LOADERS/REMOTE_FILE_SYSTEM/REMOTE_FILE' + nodeLabel='REMOTE_FILE'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/CONDITIONAL.md b/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/CONDITIONAL.md index 9e69d0b0d0..de56c41c46 100644 --- a/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/CONDITIONAL.md +++ b/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/CONDITIONAL.md @@ -1,13 +1,9 @@ ---- -title: CONDITIONAL -description: The CONDITIONAL node compares two given DataContainer inputs and enqueues nodes connected with true or false output based on the comparison result. -keyword: [Python, Flow, Logic gates, Conditional, Conditional logic gates, Python logic gates, Data analysis with conditionals, Streamline logical operations, Condition"-"based transformations, Conditional statements in Python, Python data manipulation, Accurate data insights, Logical operations using conditionals, Data processing using CONDITIONAL logic gates] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Compare two inputs - - {App1} + GLink='LOGIC_GATES/CONDITIONALS/CONDITIONAL' + nodeLabel='CONDITIONAL'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -62,10 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOGIC_GATES/CONDITIONALS/CONDITIONAL) diff --git a/docs/nodes/LOGIC_GATES/LOOPS/APPEND/APPEND.md b/docs/nodes/LOGIC_GATES/LOOPS/APPEND/APPEND.md index df28e03c2a..bca8abdc95 100644 --- a/docs/nodes/LOGIC_GATES/LOOPS/APPEND/APPEND.md +++ b/docs/nodes/LOGIC_GATES/LOOPS/APPEND/APPEND.md @@ -1,13 +1,9 @@ ---- -title: APPEND -description: The APPEND node appends a single data point to an array. The large array must be passed to the bottom array connection. For ordered pair, the single point must have a shape of 1 (or (1,)). -keyword: [Python, Flow, Logic gates, Loop, Loop"-"based appending, Python loop operations, Data manipulation with appending, Streamline data processing, Loop"-"driven transformations, Appending in Python loops, Python data analysis, Accurate data insights, Data processing using loop"-"based append, Data manipulation using APPEND in loops] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOGIC_GATES/LOOPS/APPEND/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Append a data point to an array - - {App1} + GLink='LOGIC_GATES/LOOPS/APPEND' + nodeLabel='APPEND'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOGIC_GATES/LOOPS/APPEND) diff --git a/docs/nodes/LOGIC_GATES/LOOPS/LOOP/LOOP.md b/docs/nodes/LOGIC_GATES/LOOPS/LOOP/LOOP.md index 35d3519427..50c34b0a32 100644 --- a/docs/nodes/LOGIC_GATES/LOOPS/LOOP/LOOP.md +++ b/docs/nodes/LOGIC_GATES/LOOPS/LOOP/LOOP.md @@ -1,13 +1,9 @@ ---- -title: LOOP -description: Efficiently perform Python-based looping operations with Flojoy's LOOP logic gate that iterates through the body nodes for a given number of times. -keyword: [Python, Flow, Logic gates, Loop, Loop logic gate, Python loop operations, Data manipulation with looping, Streamline data processing, Loop"-"driven transformations, Looping in Python, Python data analysis, Accurate data insights, Data processing using LOOP logic gate, Data manipulation using looping in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOGIC_GATES/LOOPS/LOOP/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Iterate through the body nodes - - {App1} + GLink='LOGIC_GATES/LOOPS/LOOP' + nodeLabel='LOOP'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOGIC_GATES/LOOPS/LOOP) diff --git a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/BREAK.md b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/BREAK.md index 91accc7dc3..ac55ee0edd 100644 --- a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/BREAK.md +++ b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/BREAK/BREAK.md @@ -1,52 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -import LoomEmbedder from '@site/src/components/LoomEmbedder'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### End the iteration of a loop +## Examples - {App1} + GLink='LOGIC_GATES/LOOP_TOOLS/BREAK' + nodeLabel='BREAK'> - + - + -[//]: # 'Appendix' +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -54,8 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - + + + + - \ No newline at end of file diff --git a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/LOOP_INDEX.md b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/LOOP_INDEX.md index 56ab2d65e9..accd2bbba1 100644 --- a/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/LOOP_INDEX.md +++ b/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX/LOOP_INDEX.md @@ -1,13 +1,9 @@ ---- -title: LOOP_INDEX -description: Efficiently perform Python-based looping operations with Flojoy's LOOP logic gate that iterates through the body nodes for a given number of times. -keyword: [Python, Flow, Logic gates, Loop, Loop logic gate, Python loop operations, Data manipulation with looping, Streamline data processing, Loop"-"driven transformations, Looping in Python, Python data analysis, Accurate data insights, Data processing using LOOP logic gate, Data manipulation using looping in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOGIC_GATES/LOOPS/LOOP_INDEX/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Track the number of loops - - {App1} + GLink='LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX' + nodeLabel='LOOP_INDEX'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOGIC_GATES/LOOP_TOOLS/LOOP_INDEX) diff --git a/docs/nodes/LOGIC_GATES/TIMERS/TIMER/TIMER.md b/docs/nodes/LOGIC_GATES/TIMERS/TIMER/TIMER.md index 2cc79ab300..cb4f68fb5f 100644 --- a/docs/nodes/LOGIC_GATES/TIMERS/TIMER/TIMER.md +++ b/docs/nodes/LOGIC_GATES/TIMERS/TIMER/TIMER.md @@ -1,13 +1,9 @@ ---- -title: TIMER -description: Efficiently manage time-based operations using Python with Flojoy's TIMER logic gate. The TIMER node sleeps for a specified number of seconds. -keyword: [Python, Flow, Logic gates, Timer, Timer logic gate, Python timer operations, Time"-"based data processing, Streamline time"-"sensitive tasks, Timer"-"driven transformations, Timer usage in Python, Python data analysis with timers, Accurate time"-"based insights, Data processing using TIMER logic gate, Time management using timers in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/LOGIC_GATES/TIMERS/TIMER/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Sleep for a number of seconds - - {App1} + GLink='LOGIC_GATES/TIMERS/TIMER' + nodeLabel='TIMER'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/LOGIC_GATES/TIMERS/TIMER) diff --git a/docs/nodes/NUMPY/LINALG/CHOLESKY/CHOLESKY.md b/docs/nodes/NUMPY/LINALG/CHOLESKY/CHOLESKY.md index 481c6f517e..43ce76a004 100644 --- a/docs/nodes/NUMPY/LINALG/CHOLESKY/CHOLESKY.md +++ b/docs/nodes/NUMPY/LINALG/CHOLESKY/CHOLESKY.md @@ -1,15 +1,10 @@ ---- -title: CHOLESKY -description: Cholesky decomposition. Return the Cholesky decomposition, `L * L.H`, of the square matrix `a`, where `L` is lower-triangular and .H is the conjugate transpose operator (which is the ordinary transpose if `a` is real-valued). `a` must be Hermitian (symmetric if real-valued) and positive-definite. No checking is performed to verify whether `a` is Hermitian or not. In addition, only the lower-triangular and diagonal elements of `a` are used. Only `L` is actually returned. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.cholesky] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Perform a Cholesky decomposition - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/CHOLESKY) + + + diff --git a/docs/nodes/NUMPY/LINALG/DET/DET.md b/docs/nodes/NUMPY/LINALG/DET/DET.md index e93525e82b..cca081e4dc 100644 --- a/docs/nodes/NUMPY/LINALG/DET/DET.md +++ b/docs/nodes/NUMPY/LINALG/DET/DET.md @@ -1,15 +1,10 @@ ---- -title: DET -description: Compute the determinant of an array. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.det] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the determinant of an array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/DET) + + + diff --git a/docs/nodes/NUMPY/LINALG/EIG/EIG.md b/docs/nodes/NUMPY/LINALG/EIG/EIG.md index a9d9769939..31c1de842c 100644 --- a/docs/nodes/NUMPY/LINALG/EIG/EIG.md +++ b/docs/nodes/NUMPY/LINALG/EIG/EIG.md @@ -1,15 +1,10 @@ ---- -title: EIG -description: Compute the eigenvalues and right eigenvectors of a square array. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.eig] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the eigenvalues and -vectors of a square array - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/EIG) diff --git a/docs/nodes/NUMPY/LINALG/EIGH/EIGH.md b/docs/nodes/NUMPY/LINALG/EIGH/EIGH.md index 6ffe52befc..171204443a 100644 --- a/docs/nodes/NUMPY/LINALG/EIGH/EIGH.md +++ b/docs/nodes/NUMPY/LINALG/EIGH/EIGH.md @@ -1,15 +1,10 @@ ---- -title: EIGH -description: Return the eigenvalues and eigenvectors of a complex Hermitian (conjugate symmetric) or a real symmetric matrix. Returns two objects, a 1-D array containing the eigenvalues of `a`, and a 2-D square array or matrix (depending on the input type) of the corresponding eigenvectors (in columns). -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.eigh] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Return the eigenvalues and -vectors of a specific matrix - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/EIGH) + + + diff --git a/docs/nodes/NUMPY/LINALG/EIGVALS/EIGVALS.md b/docs/nodes/NUMPY/LINALG/EIGVALS/EIGVALS.md index 4cec7a3a09..66580e489c 100644 --- a/docs/nodes/NUMPY/LINALG/EIGVALS/EIGVALS.md +++ b/docs/nodes/NUMPY/LINALG/EIGVALS/EIGVALS.md @@ -1,15 +1,10 @@ ---- -title: EIGVALS -description: Compute the eigenvalues of a general matrix. Main difference between `eigvals` and `eig` the eigenvectors aren't returned. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.eigvals] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the eigenvalues of a general matrix - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/EIGVALS) + + + diff --git a/docs/nodes/NUMPY/LINALG/EIGVALSH/EIGVALSH.md b/docs/nodes/NUMPY/LINALG/EIGVALSH/EIGVALSH.md index ea752f951b..980884fce8 100644 --- a/docs/nodes/NUMPY/LINALG/EIGVALSH/EIGVALSH.md +++ b/docs/nodes/NUMPY/LINALG/EIGVALSH/EIGVALSH.md @@ -1,15 +1,10 @@ ---- -title: EIGVALSH -description: Compute the eigenvalues of a complex Hermitian or real symmetric matrix. Main difference from eigh the eigenvectors are not computed. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.eigvalsh] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the eigenvalues of a specific matrix - @@ -51,17 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/EIGVALSH) + + + diff --git a/docs/nodes/NUMPY/LINALG/INV/INV.md b/docs/nodes/NUMPY/LINALG/INV/INV.md index 894fd75909..5d9caa7f37 100644 --- a/docs/nodes/NUMPY/LINALG/INV/INV.md +++ b/docs/nodes/NUMPY/LINALG/INV/INV.md @@ -1,15 +1,10 @@ ---- -title: INV -description: Compute the (multiplicative) inverse of a matrix. Given a square matrix `a`, return the matrix `ainv` satisfying ``dot(a, ainv) = dot(ainv, a) = eye(a.shape[0])``. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.inv] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the inverse of a matrix - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/INV) + + + diff --git a/docs/nodes/NUMPY/LINALG/MATRIX_POWER/MATRIX_POWER.md b/docs/nodes/NUMPY/LINALG/MATRIX_POWER/MATRIX_POWER.md index 2c00c1c779..4c70932083 100644 --- a/docs/nodes/NUMPY/LINALG/MATRIX_POWER/MATRIX_POWER.md +++ b/docs/nodes/NUMPY/LINALG/MATRIX_POWER/MATRIX_POWER.md @@ -1,15 +1,10 @@ ---- -title: MATRIX_POWER -description: Raise a square matrix to the (integer) power `n`. For positive integers `n`, the power is computed by repeated matrix squarings and matrix multiplications. If ``n == 0``, the identity matrix of the same shape as M is returned. If ``n < 0``, the inverse is computed and then raised to the ``abs(n)``. .. note Stacks of object matrices are not currently supported. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.matrix_power] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Raise a square matrix to a power - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/MATRIX_POWER) diff --git a/docs/nodes/NUMPY/LINALG/PINV/PINV.md b/docs/nodes/NUMPY/LINALG/PINV/PINV.md index 1127cedf66..7c7811bd67 100644 --- a/docs/nodes/NUMPY/LINALG/PINV/PINV.md +++ b/docs/nodes/NUMPY/LINALG/PINV/PINV.md @@ -1,15 +1,10 @@ ---- -title: PINV -description: Compute the (Moore-Penrose) pseudo-inverse of a matrix. Calculate the generalized inverse of a matrix using its singular-value decomposition (SVD) and including all *large* singular values. .. versionchanged 1.14 Can now operate on stacks of matrices -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.pinv] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the pseudo-inverse of a matrix - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/PINV) + + + diff --git a/docs/nodes/NUMPY/LINALG/QR/QR.md b/docs/nodes/NUMPY/LINALG/QR/QR.md index d9e8398b98..70a675b17b 100644 --- a/docs/nodes/NUMPY/LINALG/QR/QR.md +++ b/docs/nodes/NUMPY/LINALG/QR/QR.md @@ -1,15 +1,10 @@ ---- -title: QR -description: Compute the qr factorization of a matrix. Factor the matrix `a` as *qr*, where `q` is orthonormal and `r` is upper-triangular. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.qr] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the `qr` factorization of a matrix - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/QR) + + + diff --git a/docs/nodes/NUMPY/LINALG/SLOGDET/SLOGDET.md b/docs/nodes/NUMPY/LINALG/SLOGDET/SLOGDET.md index 5df3d629cb..8560c6f91c 100644 --- a/docs/nodes/NUMPY/LINALG/SLOGDET/SLOGDET.md +++ b/docs/nodes/NUMPY/LINALG/SLOGDET/SLOGDET.md @@ -1,15 +1,10 @@ ---- -title: SLOGDET -description: Compute the sign and (natural) logarithm of the determinant of an array. If an array has a very small or very large determinant, then a call to `det` may overflow or underflow. This routine is more robust against such issues, because it computes the logarithm of the determinant rather than the determinant itself. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.slogdet] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute specific logarithms of the determinant of an array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/SLOGDET) + + + diff --git a/docs/nodes/NUMPY/LINALG/SVD/SVD.md b/docs/nodes/NUMPY/LINALG/SVD/SVD.md index 0c1db7d8df..3a10de3bcc 100644 --- a/docs/nodes/NUMPY/LINALG/SVD/SVD.md +++ b/docs/nodes/NUMPY/LINALG/SVD/SVD.md @@ -1,15 +1,10 @@ ---- -title: SVD -description: Singular Value Decomposition. When `a` is a 2D array, and ``full_matrices=False``, then it is factorized as ``u @ np.diag(s) @ vh = (u * s) @ vh``, where `u` and the Hermitian transpose of `vh` are 2D arrays with orthonormal columns and `s` is a 1D array of `a`'s singular values. When `a` is higher-dimensional, SVD is applied in stacked mode as explained below. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.svd] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Perform a singular value decomposition - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/SVD) + + + diff --git a/docs/nodes/NUMPY/LINALG/TENSORINV/TENSORINV.md b/docs/nodes/NUMPY/LINALG/TENSORINV/TENSORINV.md index ef60d8e555..07d4dd94e9 100644 --- a/docs/nodes/NUMPY/LINALG/TENSORINV/TENSORINV.md +++ b/docs/nodes/NUMPY/LINALG/TENSORINV/TENSORINV.md @@ -1,15 +1,10 @@ ---- -title: TENSORINV -description: Compute the 'inverse' of an N-dimensional array. The result is an inverse for `a` relative to the tensordot operation ``tensordot(a, b, ind)``, i. e., up to floating-point accuracy, ``tensordot(tensorinv(a), a, ind)`` is the "identity" tensor for the tensordot operation. -keywords: [numpy, linear algerbra, linalg, np.linalg, numpy.linalg, numpy.linalg.tensorinv] -image: https://numpy.org/doc/stable/reference/routines.linalg.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the inverse of an N-dimensional array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/NUMPY/LINALG/TENSORINV) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/ARGRELMAX.md b/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/ARGRELMAX.md index 98574897aa..22452a0b56 100644 --- a/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/ARGRELMAX.md +++ b/docs/nodes/SCIPY/SIGNAL/ARGRELMAX/ARGRELMAX.md @@ -1,15 +1,10 @@ ---- -title: ARGRELMAX -description: Calculate the relative maxima of `data`. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.argrelmax] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Calculate the relative maxima of data - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/ARGRELMAX) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/ARGRELMIN.md b/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/ARGRELMIN.md index 00fb4c361f..b3aad8b4b1 100644 --- a/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/ARGRELMIN.md +++ b/docs/nodes/SCIPY/SIGNAL/ARGRELMIN/ARGRELMIN.md @@ -1,15 +1,10 @@ ---- -title: ARGRELMIN -description: Calculate the relative minima of `data`. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.argrelmin] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Calculate the relative minima of data - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/ARGRELMIN) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/BSPLINE/BSPLINE.md b/docs/nodes/SCIPY/SIGNAL/BSPLINE/BSPLINE.md index 950d92e7e6..f23f258c8f 100644 --- a/docs/nodes/SCIPY/SIGNAL/BSPLINE/BSPLINE.md +++ b/docs/nodes/SCIPY/SIGNAL/BSPLINE/BSPLINE.md @@ -1,15 +1,10 @@ ---- -title: BSPLINE -description: B-spline basis function of order n. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.bspline] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Apply a B-spline basis function - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/BSPLINE) diff --git a/docs/nodes/SCIPY/SIGNAL/CUBIC/CUBIC.md b/docs/nodes/SCIPY/SIGNAL/CUBIC/CUBIC.md index dbce19394b..598cd9b810 100644 --- a/docs/nodes/SCIPY/SIGNAL/CUBIC/CUBIC.md +++ b/docs/nodes/SCIPY/SIGNAL/CUBIC/CUBIC.md @@ -1,15 +1,10 @@ ---- -title: CUBIC -description: A cubic B-spline. This is a special case of `bspline`, and equivalent to ``bspline(x, 3)``. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.cubic] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Apply a cubic B-spline function - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/CUBIC) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/DECIMATE/DECIMATE.md b/docs/nodes/SCIPY/SIGNAL/DECIMATE/DECIMATE.md index f062b97063..f27564ca6d 100644 --- a/docs/nodes/SCIPY/SIGNAL/DECIMATE/DECIMATE.md +++ b/docs/nodes/SCIPY/SIGNAL/DECIMATE/DECIMATE.md @@ -1,15 +1,10 @@ ---- -title: DECIMATE -description: Downsample the signal after applying an anti-aliasing filter. By default, an order 8 Chebyshev type I filter is used. A 30 point FIR filter with Hamming window is used if `ftype` is 'fir'. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.decimate] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Downsample a signal with an anti-aliasing filter - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/DECIMATE) diff --git a/docs/nodes/SCIPY/SIGNAL/DETREND/DETREND.md b/docs/nodes/SCIPY/SIGNAL/DETREND/DETREND.md index 6498e975ab..705461b652 100644 --- a/docs/nodes/SCIPY/SIGNAL/DETREND/DETREND.md +++ b/docs/nodes/SCIPY/SIGNAL/DETREND/DETREND.md @@ -1,15 +1,10 @@ ---- -title: DETREND -description: Remove linear trend along axis from data. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.detrend] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Remove a linear trend along an axis - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/DETREND) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/GAUSS_SPLINE.md b/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/GAUSS_SPLINE.md index 04bb0c132f..c762e61b90 100644 --- a/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/GAUSS_SPLINE.md +++ b/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE/GAUSS_SPLINE.md @@ -1,15 +1,10 @@ ---- -title: GAUSS_SPLINE -description: Gaussian approximation to B-spline basis function of order n. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.gauss_spline] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Apply a Gaussian approximation to a B-spline basis function - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/GAUSS_SPLINE) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/HILBERT/HILBERT.md b/docs/nodes/SCIPY/SIGNAL/HILBERT/HILBERT.md index 9e6784bd39..237d143f59 100644 --- a/docs/nodes/SCIPY/SIGNAL/HILBERT/HILBERT.md +++ b/docs/nodes/SCIPY/SIGNAL/HILBERT/HILBERT.md @@ -1,15 +1,10 @@ ---- -title: HILBERT -description: Compute the analytic signal, using the Hilbert transform. The transformation is done along the last axis by default. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.hilbert] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute an analytic signal with the Hilbert transformation - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/HILBERT) diff --git a/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/KAISER_BETA.md b/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/KAISER_BETA.md index f7a0e3fdd9..c758058724 100644 --- a/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/KAISER_BETA.md +++ b/docs/nodes/SCIPY/SIGNAL/KAISER_BETA/KAISER_BETA.md @@ -1,15 +1,10 @@ ---- -title: KAISER_BETA -description: Compute the Kaiser parameter `beta`, given the attenuation `a`. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.kaiser_beta] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the Kaiser `beta` parameter - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/KAISER_BETA) diff --git a/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/PERIODOGRAM.md b/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/PERIODOGRAM.md index 30e85a0600..da55b4f48c 100644 --- a/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/PERIODOGRAM.md +++ b/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM/PERIODOGRAM.md @@ -1,15 +1,10 @@ ---- -title: PERIODOGRAM -description: Estimate power spectral density using a periodogram. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.periodogram] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Estimate power spectral density with a periodogram - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/PERIODOGRAM) diff --git a/docs/nodes/SCIPY/SIGNAL/QUADRATIC/QUADRATIC.md b/docs/nodes/SCIPY/SIGNAL/QUADRATIC/QUADRATIC.md index 982f71d3c3..4f59597f7d 100644 --- a/docs/nodes/SCIPY/SIGNAL/QUADRATIC/QUADRATIC.md +++ b/docs/nodes/SCIPY/SIGNAL/QUADRATIC/QUADRATIC.md @@ -1,15 +1,10 @@ ---- -title: QUADRATIC -description: A quadratic B-spline. This is a special case of `bspline`, and equivalent to ``bspline(x, 2)``. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.quadratic] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Apply a quadratic B-spline function - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/QUADRATIC) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/SAVGOL_FILTER.md b/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/SAVGOL_FILTER.md index 21b29c9469..fdd4733ff6 100644 --- a/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/SAVGOL_FILTER.md +++ b/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER/SAVGOL_FILTER.md @@ -1,15 +1,10 @@ ---- -title: SAVGOL_FILTER -description: Apply a Savitzky-Golay filter to an array. This is a 1-D filter. If `x` has dimension greater than 1, `axis` determines the axis along which the filter is applied. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.savgol_filter] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Apply a Savitzky-Golay filter to an array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/SAVGOL_FILTER) + + + diff --git a/docs/nodes/SCIPY/SIGNAL/STFT/STFT.md b/docs/nodes/SCIPY/SIGNAL/STFT/STFT.md index 92f5f139c9..cdeb9f10a9 100644 --- a/docs/nodes/SCIPY/SIGNAL/STFT/STFT.md +++ b/docs/nodes/SCIPY/SIGNAL/STFT/STFT.md @@ -1,15 +1,10 @@ ---- -title: STFT -description: Compute the Short Time Fourier Transform (STFT). STFTs can be used as a way of quantifying the change of a nonstationary signal's frequency and phase content over time. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.stft] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the Short Time Fourier Transform (STFT) - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/STFT) diff --git a/docs/nodes/SCIPY/SIGNAL/WELCH/WELCH.md b/docs/nodes/SCIPY/SIGNAL/WELCH/WELCH.md index c92114b564..cdf2217c51 100644 --- a/docs/nodes/SCIPY/SIGNAL/WELCH/WELCH.md +++ b/docs/nodes/SCIPY/SIGNAL/WELCH/WELCH.md @@ -1,15 +1,10 @@ ---- -title: WELCH -description: Estimate power spectral density using Welch's method. Welch's method [1]_ computes an estimate of the power spectral density by dividing the data into overlapping segments, computing a modified periodogram for each segment and averaging the periodograms. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.signal.welch] -image: https://docs.scipy.org/doc/scipy/reference/signal.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Estimate power spectral density with Welch's method - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/SIGNAL/WELCH) + + + diff --git a/docs/nodes/SCIPY/STATS/ANDERSON/ANDERSON.md b/docs/nodes/SCIPY/STATS/ANDERSON/ANDERSON.md index dbdec0253d..67159ce998 100644 --- a/docs/nodes/SCIPY/STATS/ANDERSON/ANDERSON.md +++ b/docs/nodes/SCIPY/STATS/ANDERSON/ANDERSON.md @@ -1,15 +1,10 @@ ---- -title: ANDERSON -description: Anderson-Darling test for data coming from a particular distribution. The Anderson-Darling test tests the null hypothesis that a sample is drawn from a population that follows a particular distribution. For the Anderson-Darling test, the critical values depend on which distribution is being tested against. This function works for normal, exponential, logistic, or Gumbel (Extreme Value Type I) distributions. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.anderson] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test if data comes from a particular distribution - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/ANDERSON) + + + diff --git a/docs/nodes/SCIPY/STATS/BAYES_MVS/BAYES_MVS.md b/docs/nodes/SCIPY/STATS/BAYES_MVS/BAYES_MVS.md index 4e8b126bb7..e39fb146d7 100644 --- a/docs/nodes/SCIPY/STATS/BAYES_MVS/BAYES_MVS.md +++ b/docs/nodes/SCIPY/STATS/BAYES_MVS/BAYES_MVS.md @@ -1,15 +1,10 @@ ---- -title: BAYES_MVS -description: Bayesian confidence intervals for the mean, var, and std. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.bayes_mvs] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Obtain Bayesian confidence intervals - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/BAYES_MVS) + + + diff --git a/docs/nodes/SCIPY/STATS/BINOM_TEST/BINOM_TEST.md b/docs/nodes/SCIPY/STATS/BINOM_TEST/BINOM_TEST.md index e1b6b9c0d9..373db54470 100644 --- a/docs/nodes/SCIPY/STATS/BINOM_TEST/BINOM_TEST.md +++ b/docs/nodes/SCIPY/STATS/BINOM_TEST/BINOM_TEST.md @@ -1,15 +1,10 @@ ---- -title: BINOM_TEST -description: Perform a test that the probability of success is p. Note `binom_test` is deprecated; it is recommended that `binomtest` be used instead. This is an exact, two-sided test of the null hypothesis that the probability of success in a Bernoulli experiment is `p`. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.binom_test] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test that the probability of success is p - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/BINOM_TEST) + + + diff --git a/docs/nodes/SCIPY/STATS/DESCRIBE/DESCRIBE.md b/docs/nodes/SCIPY/STATS/DESCRIBE/DESCRIBE.md index 8ff496865a..9e4a00d59e 100644 --- a/docs/nodes/SCIPY/STATS/DESCRIBE/DESCRIBE.md +++ b/docs/nodes/SCIPY/STATS/DESCRIBE/DESCRIBE.md @@ -1,15 +1,10 @@ ---- -title: DESCRIBE -description: Compute several descriptive statistics of the passed array. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.describe] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute descriptive statistics of an array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/DESCRIBE) + + + diff --git a/docs/nodes/SCIPY/STATS/GSTD/GSTD.md b/docs/nodes/SCIPY/STATS/GSTD/GSTD.md index a222e4aa76..ebdd4fbe2f 100644 --- a/docs/nodes/SCIPY/STATS/GSTD/GSTD.md +++ b/docs/nodes/SCIPY/STATS/GSTD/GSTD.md @@ -1,15 +1,10 @@ ---- -title: GSTD -description: Calculate the geometric standard deviation of an array. The geometric standard deviation describes the spread of a set of numbers where the geometric mean is preferred. It is a multiplicative factor, and so a dimensionless quantity. It is defined as the exponent of the standard deviation of ``log(a)``. Mathematically the population geometric standard deviation can be evaluated as gstd = exp(std(log(a))) .. versionadded 1.3.0 -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.gstd] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Calculate the geometric standard deviation of an array - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/GSTD) diff --git a/docs/nodes/SCIPY/STATS/GZSCORE/GZSCORE.md b/docs/nodes/SCIPY/STATS/GZSCORE/GZSCORE.md index df583b72eb..91983f5273 100644 --- a/docs/nodes/SCIPY/STATS/GZSCORE/GZSCORE.md +++ b/docs/nodes/SCIPY/STATS/GZSCORE/GZSCORE.md @@ -1,15 +1,10 @@ ---- -title: GZSCORE -description: Compute the geometric standard score. Compute the geometric z score of each strictly positive value in the sample, relative to the geometric mean and standard deviation. Mathematically the geometric z score can be evaluated as gzscore = log(a/gmu) / log(gsigma) where ``gmu`` (resp. ``gsigma``) is the geometric mean (resp. standard deviation). -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.gzscore] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the geometric standard score - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/GZSCORE) diff --git a/docs/nodes/SCIPY/STATS/JARQUE_BERA/JARQUE_BERA.md b/docs/nodes/SCIPY/STATS/JARQUE_BERA/JARQUE_BERA.md index 5c08117651..2ff3b7d2b2 100644 --- a/docs/nodes/SCIPY/STATS/JARQUE_BERA/JARQUE_BERA.md +++ b/docs/nodes/SCIPY/STATS/JARQUE_BERA/JARQUE_BERA.md @@ -1,15 +1,10 @@ ---- -title: JARQUE_BERA -description: Perform the Jarque-Bera goodness of fit test on sample data. The Jarque-Bera test tests whether the sample data has the skewness and kurtosis matching a normal distribution. Note that this test only works for a large enough number of data samples (>2000) as the test statistic asymptotically has a Chi-squared distribution with 2 degrees of freedom. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.jarque_bera] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Perform a Jarque-Bera goodness of fit test - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/JARQUE_BERA) diff --git a/docs/nodes/SCIPY/STATS/KURTOSIS/KURTOSIS.md b/docs/nodes/SCIPY/STATS/KURTOSIS/KURTOSIS.md index c83edf5cd1..eac87f93f3 100644 --- a/docs/nodes/SCIPY/STATS/KURTOSIS/KURTOSIS.md +++ b/docs/nodes/SCIPY/STATS/KURTOSIS/KURTOSIS.md @@ -1,15 +1,10 @@ ---- -title: KURTOSIS -description: Compute the kurtosis (Fisher or Pearson) of a dataset. Kurtosis is the fourth central moment divided by the square of the variance. If Fisher's definition is used, then 3.0 is subtracted from the result to give 0.0 for a normal distribution. If bias is False then the kurtosis is calculated using k statistics to eliminate bias coming from biased moment estimators Use `kurtosistest` to see if result is close enough to normal. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.kurtosis] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the kurtosis of a dataset - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/KURTOSIS) + + + diff --git a/docs/nodes/SCIPY/STATS/KURTOSISTEST/KURTOSISTEST.md b/docs/nodes/SCIPY/STATS/KURTOSISTEST/KURTOSISTEST.md index d27e1b6e80..e13aa0790d 100644 --- a/docs/nodes/SCIPY/STATS/KURTOSISTEST/KURTOSISTEST.md +++ b/docs/nodes/SCIPY/STATS/KURTOSISTEST/KURTOSISTEST.md @@ -1,15 +1,10 @@ ---- -title: KURTOSISTEST -description: Test whether a dataset has normal kurtosis. This function tests the null hypothesis that the kurtosis of the population from which the sample was drawn is that of the normal distribution. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.kurtosistest] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test whether a dataset has a normal kurtosis - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/KURTOSISTEST) + + + diff --git a/docs/nodes/SCIPY/STATS/MOMENT/MOMENT.md b/docs/nodes/SCIPY/STATS/MOMENT/MOMENT.md index 1e26a673e3..1879267bdb 100644 --- a/docs/nodes/SCIPY/STATS/MOMENT/MOMENT.md +++ b/docs/nodes/SCIPY/STATS/MOMENT/MOMENT.md @@ -1,15 +1,10 @@ ---- -title: MOMENT -description: Calculate the nth moment about the mean for a sample. A moment is a specific quantitative measure of the shape of a set of points. It is often used to calculate coefficients of skewness and kurtosis due to its close relationship with them. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.moment] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Calculate the nth moment about the mean - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/MOMENT) + + + diff --git a/docs/nodes/SCIPY/STATS/MVSDIST/MVSDIST.md b/docs/nodes/SCIPY/STATS/MVSDIST/MVSDIST.md index f3ff8d4663..90b09741c7 100644 --- a/docs/nodes/SCIPY/STATS/MVSDIST/MVSDIST.md +++ b/docs/nodes/SCIPY/STATS/MVSDIST/MVSDIST.md @@ -1,15 +1,10 @@ ---- -title: MVSDIST -description: Frozen distributions for mean, variance, and standard deviation of data. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.mvsdist] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Obtain 'Frozen' distributions - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/MVSDIST) + + + diff --git a/docs/nodes/SCIPY/STATS/NORMALTEST/NORMALTEST.md b/docs/nodes/SCIPY/STATS/NORMALTEST/NORMALTEST.md index 594b7edb46..4e157085fc 100644 --- a/docs/nodes/SCIPY/STATS/NORMALTEST/NORMALTEST.md +++ b/docs/nodes/SCIPY/STATS/NORMALTEST/NORMALTEST.md @@ -1,15 +1,10 @@ ---- -title: NORMALTEST -description: Test whether a sample differs from a normal distribution. This function tests the null hypothesis that a sample comes from a normal distribution. It is based on D'Agostino and Pearson's [1]_, [2]_ test that combines skew and kurtosis to produce an omnibus test of normality. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.normaltest] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test if a sample differs from a normal distribution - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/NORMALTEST) + + + diff --git a/docs/nodes/SCIPY/STATS/SEM/SEM.md b/docs/nodes/SCIPY/STATS/SEM/SEM.md index 0d72215564..37a1a296ef 100644 --- a/docs/nodes/SCIPY/STATS/SEM/SEM.md +++ b/docs/nodes/SCIPY/STATS/SEM/SEM.md @@ -1,15 +1,10 @@ ---- -title: SEM -description: Compute standard error of the mean. Calculate the standard error of the mean (or standard error of measurement) of the values in the input array. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.sem] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the standard error of the mean - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/SEM) diff --git a/docs/nodes/SCIPY/STATS/SHAPIRO/SHAPIRO.md b/docs/nodes/SCIPY/STATS/SHAPIRO/SHAPIRO.md index d0a53583e3..cf15548245 100644 --- a/docs/nodes/SCIPY/STATS/SHAPIRO/SHAPIRO.md +++ b/docs/nodes/SCIPY/STATS/SHAPIRO/SHAPIRO.md @@ -1,15 +1,10 @@ ---- -title: SHAPIRO -description: Perform the Shapiro-Wilk test for normality. The Shapiro-Wilk test tests the null hypothesis that the data was drawn from a normal distribution. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.shapiro] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test for normality with the Shapiro-Wilk test - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/SHAPIRO) + + + diff --git a/docs/nodes/SCIPY/STATS/SIGMACLIP/SIGMACLIP.md b/docs/nodes/SCIPY/STATS/SIGMACLIP/SIGMACLIP.md index 38b44fdd01..862a91bef6 100644 --- a/docs/nodes/SCIPY/STATS/SIGMACLIP/SIGMACLIP.md +++ b/docs/nodes/SCIPY/STATS/SIGMACLIP/SIGMACLIP.md @@ -1,15 +1,10 @@ ---- -title: SIGMACLIP -description: Perform iterative sigma-clipping of array elements. Starting from the full sample, all elements outside the critical range are removed, i.e. all elements of the input array `c` that satisfy either of the following conditions c < mean(c) - std(c)*low c > mean(c) + std(c)*high The iteration continues with the updated sample until no elements are outside the (updated) range. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.sigmaclip] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Perform iterative sigma-clipping of array elements - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/SIGMACLIP) diff --git a/docs/nodes/SCIPY/STATS/SKEW/SKEW.md b/docs/nodes/SCIPY/STATS/SKEW/SKEW.md index 1c549b5f04..d3e88da790 100644 --- a/docs/nodes/SCIPY/STATS/SKEW/SKEW.md +++ b/docs/nodes/SCIPY/STATS/SKEW/SKEW.md @@ -1,15 +1,10 @@ ---- -title: SKEW -description: Compute the sample skewness of a data set. For normally distributed data, the skewness should be about zero. For unimodal continuous distributions, a skewness value greater than zero means that there is more weight in the right tail of the distribution. The function `skewtest` can be used to determine if the skewness value is close enough to zero, statistically speaking. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.skew] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the skewness of a dataset - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/SKEW) + + + diff --git a/docs/nodes/SCIPY/STATS/SKEWTEST/SKEWTEST.md b/docs/nodes/SCIPY/STATS/SKEWTEST/SKEWTEST.md index 65b01f84ff..ae22df9b58 100644 --- a/docs/nodes/SCIPY/STATS/SKEWTEST/SKEWTEST.md +++ b/docs/nodes/SCIPY/STATS/SKEWTEST/SKEWTEST.md @@ -1,15 +1,10 @@ ---- -title: SKEWTEST -description: Test whether the skew is different from the normal distribution. This function tests the null hypothesis that the skewness of the population that the sample was drawn from is the same as that of a corresponding normal distribution. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.skewtest] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Test whether a dataset has a normal skewness - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/SKEWTEST) + + + diff --git a/docs/nodes/SCIPY/STATS/TMAX/TMAX.md b/docs/nodes/SCIPY/STATS/TMAX/TMAX.md index f49ad3b497..bf1bbf2787 100644 --- a/docs/nodes/SCIPY/STATS/TMAX/TMAX.md +++ b/docs/nodes/SCIPY/STATS/TMAX/TMAX.md @@ -1,15 +1,10 @@ ---- -title: TMAX -description: Compute the trimmed maximum. This function computes the maximum value of an array along a given axis, while ignoring values larger than a specified upper limit. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.tmax] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the trimmed maximum - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TMAX) + + + diff --git a/docs/nodes/SCIPY/STATS/TMIN/TMIN.md b/docs/nodes/SCIPY/STATS/TMIN/TMIN.md index 4bff5808ef..a24323e7f9 100644 --- a/docs/nodes/SCIPY/STATS/TMIN/TMIN.md +++ b/docs/nodes/SCIPY/STATS/TMIN/TMIN.md @@ -1,15 +1,10 @@ ---- -title: TMIN -description: Compute the trimmed minimum. This function finds the miminum value of an array `a` along the specified axis, but only considering values greater than a specified lower limit. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.tmin] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the trimmed minimum - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TMIN) + + + diff --git a/docs/nodes/SCIPY/STATS/TRIM1/TRIM1.md b/docs/nodes/SCIPY/STATS/TRIM1/TRIM1.md index 4feb5300c3..3712c211fd 100644 --- a/docs/nodes/SCIPY/STATS/TRIM1/TRIM1.md +++ b/docs/nodes/SCIPY/STATS/TRIM1/TRIM1.md @@ -1,15 +1,10 @@ ---- -title: TRIM1 -description: Slice off a proportion from ONE end of the passed array distribution. If `proportiontocut` = 0.1, slices off 'leftmost' or 'rightmost' 10% of scores. The lowest or highest values are trimmed (depending on the tail). Slice off less if proportion results in a non-integer slice index (i.e. conservatively slices off `proportiontocut` ). -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.trim1] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Trim a proportion from one end of an array - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TRIM1) + + + diff --git a/docs/nodes/SCIPY/STATS/TRIMBOTH/TRIMBOTH.md b/docs/nodes/SCIPY/STATS/TRIMBOTH/TRIMBOTH.md index b9b0622af5..2e64dde316 100644 --- a/docs/nodes/SCIPY/STATS/TRIMBOTH/TRIMBOTH.md +++ b/docs/nodes/SCIPY/STATS/TRIMBOTH/TRIMBOTH.md @@ -1,15 +1,10 @@ ---- -title: TRIMBOTH -description: Slice off a proportion of items from both ends of an array. Slice off the passed proportion of items from both ends of the passed array (i.e., with `proportiontocut` = 0.1, slices leftmost 10% **and** rightmost 10% of scores). The trimmed values are the lowest and highest ones. Slice off less if proportion results in a non-integer slice index (i.e. conservatively slices off `proportiontocut`). -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.trimboth] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Trim a proportion from both ends of an array - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub + + + -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TRIMBOTH) diff --git a/docs/nodes/SCIPY/STATS/TRIM_MEAN/TRIM_MEAN.md b/docs/nodes/SCIPY/STATS/TRIM_MEAN/TRIM_MEAN.md index d8955fb257..a94766fd2d 100644 --- a/docs/nodes/SCIPY/STATS/TRIM_MEAN/TRIM_MEAN.md +++ b/docs/nodes/SCIPY/STATS/TRIM_MEAN/TRIM_MEAN.md @@ -1,15 +1,10 @@ ---- -title: TRIM_MEAN -description: Return mean of array after trimming distribution from both tails. If `proportiontocut` = 0.1, slices off 'leftmost' and 'rightmost' 10% of scores. The input is sorted before slicing. Slices off less if proportion results in a non-integer slice index (i.e., conservatively slices off `proportiontocut` ). -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.trim_mean] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Trim from both tails and return the mean of an array - @@ -51,15 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TRIM_MEAN) diff --git a/docs/nodes/SCIPY/STATS/TTEST_1SAMP/TTEST_1SAMP.md b/docs/nodes/SCIPY/STATS/TTEST_1SAMP/TTEST_1SAMP.md index a8582a8220..cfcc33665f 100644 --- a/docs/nodes/SCIPY/STATS/TTEST_1SAMP/TTEST_1SAMP.md +++ b/docs/nodes/SCIPY/STATS/TTEST_1SAMP/TTEST_1SAMP.md @@ -1,15 +1,10 @@ ---- -title: TTEST_1SAMP -description: Calculate the T-test for the mean of ONE group of scores. This is a test for the null hypothesis that the expected value (mean) of a sample of independent observations `a` is equal to the given population mean, `popmean`. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.ttest_1samp] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Calculate the T-test for the mean of one group of scores - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/TTEST_1SAMP) diff --git a/docs/nodes/SCIPY/STATS/VARIATION/VARIATION.md b/docs/nodes/SCIPY/STATS/VARIATION/VARIATION.md index 0922afebc8..78d63ac6ec 100644 --- a/docs/nodes/SCIPY/STATS/VARIATION/VARIATION.md +++ b/docs/nodes/SCIPY/STATS/VARIATION/VARIATION.md @@ -1,15 +1,10 @@ ---- -title: VARIATION -description: Compute the coefficient of variation. The coefficient of variation is the standard deviation divided by the mean. This function is equivalent to np.std(x, axis=axis, ddof=ddof) / np.mean(x) The default for ``ddof`` is 0, but many definitions of the coefficient of variation use the square root of the unbiased sample variance for the sample standard deviation, which corresponds to ``ddof=1``. The function does not take the absolute value of the mean of the data, so the return value is negative if the mean is negative. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.variation] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the coefficient of variation - @@ -51,14 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) + + + -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/VARIATION) diff --git a/docs/nodes/SCIPY/STATS/YEOJOHNSON/YEOJOHNSON.md b/docs/nodes/SCIPY/STATS/YEOJOHNSON/YEOJOHNSON.md index e5559184de..870d01100a 100644 --- a/docs/nodes/SCIPY/STATS/YEOJOHNSON/YEOJOHNSON.md +++ b/docs/nodes/SCIPY/STATS/YEOJOHNSON/YEOJOHNSON.md @@ -1,15 +1,10 @@ ---- -title: YEOJOHNSON -description: Return a dataset transformed by a Yeo-Johnson power transformation. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.yeojohnson] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Transform a dataset with the Yeo-Johnson power transformation - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/YEOJOHNSON) + + + diff --git a/docs/nodes/SCIPY/STATS/ZSCORE/ZSCORE.md b/docs/nodes/SCIPY/STATS/ZSCORE/ZSCORE.md index 894166765d..878899a15a 100644 --- a/docs/nodes/SCIPY/STATS/ZSCORE/ZSCORE.md +++ b/docs/nodes/SCIPY/STATS/ZSCORE/ZSCORE.md @@ -1,15 +1,10 @@ ---- -title: ZSCORE -description: Compute the z score. Compute the z score of each value in the sample, relative to the sample mean and standard deviation. -keywords: [scipy, statistics, signal processing, scipy.stats, scipy.signal, scipy.stats.zscore] -image: https://docs.scipy.org/doc/scipy/reference/stats.html ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; -import PythonCode from '@site/src/components/PythonCode'; +import DocStringJSON from '@site/src/components/DocStringJSON'; +import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; @@ -17,12 +12,12 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; - {DocstringSource} -{PythonSource} - + +{PythonSource} @@ -32,10 +27,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -### Compute the z-score - @@ -51,16 +44,8 @@ import Media from './appendix/media.md'; ## Appendix - - - - - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/SCIPY/STATS/ZSCORE) + + + diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/ABS.md b/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/ABS.md index 53f454eff6..2741c6f73d 100644 --- a/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/ABS.md +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/ABS.md @@ -1,13 +1,9 @@ ---- -title: ABS -description: Perform Python"-"based absolute value calculations effortlessly with Flojoy's ABS transformer. Streamline data processing and analysis for accurate insights. -keyword: [Python,Transform, Arithmetic, Absolute value transformer, Python ABS calculations, Data processing with ABS, Flojoy ABS transformer, Streamline data analysis, Arithmetic transformations, Absolute value calculation, Python data manipulation, Accurate data insights, ABS transformation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Return an absolute value - - {App1} + GLink='TRANSFORMERS/ARITHMETIC/ABS' + nodeLabel='ABS'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/ARITHMETIC/ABS) diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/ADD.md b/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/ADD.md index 2602151970..d421077abe 100644 --- a/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/ADD.md +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/ADD.md @@ -1,13 +1,9 @@ ---- -title: ADD -description: Add 2 or more numeric arrays, matrices, dataframes, or constants element-wise. When a constant is added to an array or matrix, each element in the array or matrix will be increased by the constant value. -keyword: [Python, Transform, Arithmetic, Addition transformer, Python addition calculations, Data processing with addition, Flojoy ADD transformer, Streamline data analysis, Arithmetic transformations, Addition calculation, Python data manipulation, Accurate data insights, ADD transformation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Add different inputs - - {App1} + GLink='TRANSFORMERS/ARITHMETIC/ADD' + nodeLabel='ADD'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/ARITHMETIC/ADD) diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/DIVIDE.md b/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/DIVIDE.md index 7d76a612fd..86bc98fd4e 100644 --- a/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/DIVIDE.md +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/DIVIDE.md @@ -1,13 +1,9 @@ ---- -title: DIVIDE -description: Divide 2 or more numeric arrays matrices, dataframes, or constants element-wise. When a constant is divided to an array or matrix, each element in the array or matrix will be increased by the constant value. -keyword: [Python, Transform, Arithmetic, Division transformer, Python division calculations, Data processing with division, Flojoy DIVIDE transformer, Streamline data analysis, Arithmetic transformations, Division calculation, Python data manipulation, Accurate data insights, DIVIDE transformation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Divide different inputs - - {App1} + GLink='TRANSFORMERS/ARITHMETIC/DIVIDE' + nodeLabel='DIVIDE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/ARITHMETIC/DIVIDE) diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/MULTIPLY.md b/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/MULTIPLY.md index e83e0a334e..2c86e750be 100644 --- a/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/MULTIPLY.md +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/MULTIPLY.md @@ -1,13 +1,9 @@ ---- -title: MULTIPLY -description: Effortlessly perform Python-based multiplication calculations with Flojoy's MULTIPLY transformer. Takes 2 input vectors, multiplies them, and returns the result. -keyword: [Python, Transform, Arithmetic, Multiply, Multiplication transformer, Python multiplication calculations, Data processing with multiplication, Flojoy MULTIPLY transformer, Streamline data analysis, Arithmetic transformations, Multiplication calculation, Python data manipulation, Accurate data insights, MULTIPLY transformation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Multiply different inputs - - {App1} + GLink='TRANSFORMERS/ARITHMETIC/MULTIPLY' + nodeLabel='MULTIPLY'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/ARITHMETIC/MULTIPLY) diff --git a/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/SUBTRACT.md b/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/SUBTRACT.md index f4f7353e75..88422bfb87 100644 --- a/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/SUBTRACT.md +++ b/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/SUBTRACT.md @@ -1,13 +1,9 @@ ---- -title: SUBTRACT -description: Effortlessly perform Python-based subtraction calculations with Flojoy's SUBTRACT transformer. Subtract 2 input vectors and return the result. -keyword: [Python, Transform, Arithmetic, Subtract, Subtraction transformer, Python subtraction calculations, Data processing with subtraction, Flojoy SUBTRACT transformer, Streamline data analysis, Arithmetic transformations, Subtraction calculation, Python data manipulation, Accurate data insights, SUBTRACT transformation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Subtract different inputs - - {App1} + GLink='TRANSFORMERS/ARITHMETIC/SUBTRACT' + nodeLabel='SUBTRACT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/ARITHMETIC/SUBTRACT) diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/DIFFERENTIATE.md b/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/DIFFERENTIATE.md index d22d4570d9..3a998bc48b 100644 --- a/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/DIFFERENTIATE.md +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/DIFFERENTIATE.md @@ -1,13 +1,9 @@ ---- -title: DIFFERENTIATE -description: The Python powered DIFFERENTIATE node takes two list, x and y, as input. It computes the derivative of the array, y with respect to x. -keyword: [Python, Transform, Calculus, Differentiate, Differentiation transformer, Calculus operations in Python, Data differentiation with Flojoy, Python differentiation calculations, Streamline data analysis, Calculus transformations, Differential calculus, Python data manipulation, Accurate data insights, Differentiation in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Compute the derivative of y with respect to x - - {App1} + GLink='TRANSFORMERS/CALCULUS/DIFFERENTIATE' + nodeLabel='DIFFERENTIATE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/CALCULUS/DIFFERENTIATE) diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/DOUBLE_DEFINITE_INTEGRAL.md b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/DOUBLE_DEFINITE_INTEGRAL.md index 83a59b7457..03b8852158 100644 --- a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/DOUBLE_DEFINITE_INTEGRAL.md +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/DOUBLE_DEFINITE_INTEGRAL.md @@ -1,14 +1,9 @@ ---- -title: DOUBLE_DEFINITE_INTEGRAL -description: The DEFINITE_INTEGRAL node takes a function, upper, and lower bounds as input. It computes double integral of the given function. -keyword: [Python, Transform, Calculus, Definite integral, Double definite integral transformer, Calculus operations in Python, Data integration with Flojoy, Python integration calculations, -Calculus transformations, Double integral calculation, Python data manipulation, Accurate data insights, Definite integration in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -17,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Compute a double integral of a given function - - {App1} + GLink='TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL' + nodeLabel='DOUBLE_DEFINITE_INTEGRAL'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_DEFINITE_INTEGRAL) diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/DOUBLE_INDEFINITE_INTEGRAL.md b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/DOUBLE_INDEFINITE_INTEGRAL.md index aea0d869a1..c1b3b48c62 100644 --- a/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/DOUBLE_INDEFINITE_INTEGRAL.md +++ b/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/DOUBLE_INDEFINITE_INTEGRAL.md @@ -1,14 +1,9 @@ ---- -title: DOUBLE_INDEFINITE_INTEGRAL -description: The DOUBLE_INDEFINITE_INTEGRAL node takes an OrderedTriple (x,y,z) and have the width and height parameter. It computes the double integral approximation according to the matrices dimensions given and it returns a matrix where each cell represents volume up to the given point. -keyword: [Python, Transform, Calculus, Indefinite integral, Double indefinite integral transformer, Calculus operations in Python, Data integration with Flojoy, Python integration calculations, -Calculus transformations, Double integral calculation, Python data manipulation, Accurate data insights, Indefinite integration in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -17,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Compute a double integral from x, y, and z - - {App1} + GLink='TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL' + nodeLabel='DOUBLE_INDEFINITE_INTEGRAL'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/CALCULUS/DOUBLE_INDEFINITE_INTEGRAL) diff --git a/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/INTEGRATE.md b/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/INTEGRATE.md index 0458fef5d5..5c380a0324 100644 --- a/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/INTEGRATE.md +++ b/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/INTEGRATE.md @@ -1,13 +1,9 @@ ---- -title: INTEGRATE -description: The Python"-"powered INTEGRATE node takes two lists as input and integrates it using the composite trapezoidal rule. -keyword: [Python, Transform, Calculus, Integrate, Integration transformer, Python integration calculations, Data processing with integration, Flojoy INTEGRATE transformer, Streamline data analysis, Calculus transformations, Integration calculation, Python data manipulation, Accurate data insights, Integration in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply the trapezoidal rule to compute an integration - - {App1} + GLink='TRANSFORMERS/CALCULUS/INTEGRATE' + nodeLabel='INTEGRATE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/CALCULUS/INTEGRATE) diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/CHANNEL_MERGE.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/CHANNEL_MERGE.md index 79ce0fd3ae..05d7cbde22 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/CHANNEL_MERGE.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE/CHANNEL_MERGE.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Merge the `rgba` channels of an image - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_MERGE' + nodeLabel='CHANNEL_MERGE'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/CHANNEL_SPLIT.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/CHANNEL_SPLIT.md index 5948872095..c97c698448 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/CHANNEL_SPLIT.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT/CHANNEL_SPLIT.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Split the `rgba` channels of an image - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/CHANNEL_SPLIT' + nodeLabel='CHANNEL_SPLIT'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/EDGE_DETECTION.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/EDGE_DETECTION.md index 79a8807914..7544d9d5c9 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/EDGE_DETECTION.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/EDGE_DETECTION.md @@ -1,13 +1,9 @@ ---- -title: EDGE_DETECTION -description: The EDGE_DETECTION node detects edges in the image passed to it. This is done through the the Pillow image filter FIND_EDGES. The image is converted to greyscale during this processing. -keyword: [Python, Transform, Image processing, Edge detection, Image processing in Python, Data analysis with edge detection, Python edge detection algorithms, Streamline image analysis, Image processing transformations, Edge detection techniques, Python image manipulation, Accurate image insights, Image feature extraction using edges] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Detect the edges in an image - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION' + nodeLabel='EDGE_DETECTION'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EDGE_DETECTION) diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/EXTREMA_DETERMINATION.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/EXTREMA_DETERMINATION.md index ff63f303b9..efb4cf4d73 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/EXTREMA_DETERMINATION.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION/EXTREMA_DETERMINATION.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Determine the peak in an image - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/EXTREMA_DETERMINATION' + nodeLabel='EXTREMA_DETERMINATION'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/IMAGE_SMOOTHING.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/IMAGE_SMOOTHING.md index 4d69810f4f..35e7bdbe93 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/IMAGE_SMOOTHING.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/IMAGE_SMOOTHING.md @@ -1,13 +1,9 @@ ---- -title: IMAGE_SMOOTHING -description: Apply image smoothing operation on the input DataContainer class, specifically for the image type, represented by the RGB(A) channels. -keyword: [Python, Transform, Image processing, Image smoothing transformer, Python image processing, Data analysis with image smoothing, Python image filtering techniques, Streamline image analysis, Image processing transformations, Image smoothing algorithms, Python image manipulation, Accurate image insights, Image noise reduction using smoothing] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply an image smoothing function - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING' + nodeLabel='IMAGE_SMOOTHING'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/IMAGE_SMOOTHING) diff --git a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/REGION_PROPERTIES.md b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/REGION_PROPERTIES.md index 16cac06fcf..b1baa705ee 100644 --- a/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/REGION_PROPERTIES.md +++ b/docs/nodes/TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES/REGION_PROPERTIES.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Process and visualize the regions of an image - - {App1} + GLink='TRANSFORMERS/IMAGE_PROCESSING/REGION_PROPERTIES' + nodeLabel='REGION_PROPERTIES'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/DOT_PRODUCT.md b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/DOT_PRODUCT.md index 80bcc25ac6..8b085b0937 100644 --- a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/DOT_PRODUCT.md +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT/DOT_PRODUCT.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} - + + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Multiply matrices by dot product - - {App1} + GLink='TRANSFORMERS/MATRIX_MANIPULATION/DOT_PRODUCT' + nodeLabel='DOT_PRODUCT'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/INVERT.md b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/INVERT.md index 49e22cff4a..207a472c60 100644 --- a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/INVERT.md +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/INVERT.md @@ -1,13 +1,9 @@ ---- -title: INVERT -description: Takes 2 inputs, one matrix and one rcond if not square matrix, inverts them (or pseudo invert) and returns the result. If the entered value is a scalar it returns the multiplciative inverse 1/x. -keyword: [Python, Transform, Matrix manipulation, Matrix inversion transformer, Python matrix manipulation, Data analysis with matrix inversion, Python matrix calculations, Streamline data manipulation, Matrix transformation techniques, Matrix inversion algorithms, Python data manipulation, Accurate data insights, Matrix inversion for analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Invert a matrix - - {App1} + GLink='TRANSFORMERS/MATRIX_MANIPULATION/INVERT' + nodeLabel='INVERT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/INVERT) diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/MATMUL.md b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/MATMUL.md index 9f048fa747..f29c30e073 100644 --- a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/MATMUL.md +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/MATMUL.md @@ -1,13 +1,9 @@ ---- -title: MATMUL -description: Efficiently perform Python"-"based matrix multiplication with Flojoy's MATMUL transformer. The node takes two input matrices, multiplies them, and returns the result. -keyword: [Python, Transform, Matrix manipulation, Matrix multiplication transformer, Python matrix manipulation, Data processing with MATMUL, Python matrix calculations, Streamline data analysis, Matrix transformation techniques, Matrix multiplication algorithms, Python data manipulation, Accurate data insights, Matrix multiplication in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Multiply two matrices - - {App1} + GLink='TRANSFORMERS/MATRIX_MANIPULATION/MATMUL' + nodeLabel='MATMUL'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/MATMUL) diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/SHUFFLE_MATRIX.md b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/SHUFFLE_MATRIX.md index b687e4831e..7615e984af 100644 --- a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/SHUFFLE_MATRIX.md +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX/SHUFFLE_MATRIX.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Randomly shuffle a matrix - - {App1} + GLink='TRANSFORMERS/MATRIX_MANIPULATION/SHUFFLE_MATRIX' + nodeLabel='SHUFFLE_MATRIX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/SORT_MATRIX.md b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/SORT_MATRIX.md index 00fac20c91..2e8a376e4f 100644 --- a/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/SORT_MATRIX.md +++ b/docs/nodes/TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX/SORT_MATRIX.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Sort a matrix by the input axis - - {App1} + GLink='TRANSFORMERS/MATRIX_MANIPULATION/SORT_MATRIX' + nodeLabel='SORT_MATRIX'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/ORDERED_PAIR_XY_INVERT.md b/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/ORDERED_PAIR_XY_INVERT.md index a739bcda4e..c4398d0006 100644 --- a/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/ORDERED_PAIR_XY_INVERT.md +++ b/docs/nodes/TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT/ORDERED_PAIR_XY_INVERT.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Invert the X and Y axes of an OrderedPair - - {App1} + GLink='TRANSFORMERS/ORDERED_PAIR_MANIPULATION/ORDERED_PAIR_XY_INVERT' + nodeLabel='ORDERED_PAIR_XY_INVERT'> - - - + + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/BUTTER.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/BUTTER.md index e5b91a87e5..474a1ddc88 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/BUTTER.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/BUTTER.md @@ -1,13 +1,9 @@ ---- -title: BUTTER -description: The BUTTER node applies a butterworth filter to an input signal. It is designed to have a frequency response that is as flat as possible in the pass band. -keyword: [Python, Transform, Signal processing, Butterworth filter transformer, Signal processing in Python, Data filtering with Butterworth, Python filter calculations, Streamline data analysis, Signal processing transformations, Butterworth filter design, Python data manipulation, Accurate data insights, Signal filtering using Butterworth] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply a butterworth filter to an input signal - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/BUTTER' + nodeLabel='BUTTER'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/BUTTER) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/FFT.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/FFT.md index 68ca1f1348..0462e68a68 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/FFT.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/FFT.md @@ -1,13 +1,9 @@ ---- -title: FFT -description: The FFT node performs a Discrete Fourier Transform on the input vector. The input vector will be transformed from the time domain into the frequency domain which will be an ordered pair of arrays. -keyword: [Python, Transform, Signal processing, FFT transformer, Python Fast Fourier Transform, Signal processing with FFT, Python frequency analysis, Streamline data analysis, Signal processing transformations, FFT calculation in Python, Python data manipulation, Accurate data insights, Frequency analysis using FFT] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Transform a vector with the FFT algorithm - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/FFT' + nodeLabel='FFT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FFT) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/FIR.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/FIR.md index 5965043e6e..59eccc836b 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/FIR.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/FIR.md @@ -1,13 +1,9 @@ ---- -title: FIR -description: The FIR node applies a low-pass FIR filter to an input vector. The filter is designed with the window method. -keyword: [Python, Transform, Signal processing, FIR filter transformer, Signal processing in Python, Data filtering with FIR, Python filter calculations, Streamline data analysis, Signal processing transformations, FIR filter design, Python data manipulation, Accurate data insights, FIR filtering in Python] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply a FIR filter to a vector - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/FIR' + nodeLabel='FIR'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/FIR) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/IFFT.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/IFFT.md index 0c338ef1d4..36c4304213 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/IFFT.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/IFFT.md @@ -1,13 +1,9 @@ ---- -title: IFFT -description: The IFFT performs the Inverse Discrete Fourier Transform on the input signal. With the IFFT algorith, the input signal will be transformed from the frequency domain back into the time domain. -keyword: [Python, Transform, Signal processing, IFFT transformer, Python Inverse Fast Fourier Transform, Signal processing with IFFT, Python frequency analysis, Streamline data analysis, Signal processing transformations, IFFT calculation in Python, Python data manipulation, Accurate data insights, Inverse frequency analysis using IFFT] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Transform a signal with the IFFT algorithm - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/IFFT' + nodeLabel='IFFT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/IFFT) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/PID.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/PID.md index b0040f1503..4e99098529 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/PID.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/PID.md @@ -1,13 +1,9 @@ ---- -title: PID -description: The PID node acts like a PID function. The returned value with be modified according to the PID parameters Kp, Ki, and Kd. -keyword: [Python, Transform, Signal processing, PID transformer, Signal processing in Python, Data control with PID, Python PID calculations, Streamline data analysis, Signal processing transformations, PID control system, Python data manipulation, Accurate data insights, Control system using PID] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply a PID function - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/PID' + nodeLabel='PID'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/PID) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/SAVGOL.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/SAVGOL.md index 1d01112a7c..592a845122 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/SAVGOL.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/SAVGOL.md @@ -1,13 +1,9 @@ ---- -title: SAVGOL -description: Apply a Savitzky-Golay filter to an input signal, which is generally used for smoothing data. The default behaviour is implementing a 3-point moving average of the data. -keyword: [Python, Transform, Signal processing, Savitzky-Golay filter transformer, Signal processing in Python, Data smoothing with SavGol, Python filter calculations, Streamline data analysis, Signal processing transformations, Savitzky-Golay filter design, Python data manipulation, Accurate data insights, Data smoothing using SavGol] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,52 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import outputImg from './examples/EX1/output.jpeg' - -### Smooth a signal with a Savitzky-Golay filter - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL' + nodeLabel='SAVGOL'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/SAVGOL) diff --git a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/TWO_DIMENSIONAL_FFT.md b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/TWO_DIMENSIONAL_FFT.md index 0659d3aef9..3747fc1fce 100644 --- a/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/TWO_DIMENSIONAL_FFT.md +++ b/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/TWO_DIMENSIONAL_FFT.md @@ -1,13 +1,9 @@ ---- -title: TWO_DIMENSIONAL_FFT -description: The Python"-"powered TWO_DIMENSIONAL_FFT node performs a two"-"dimensional fourier transform on the input matrix. -keyword: [Python, Transform, Signal processing, Two-dimensional FFT transformer, Signal processing in Python, Data analysis with 2D FFT, Python frequency analysis, Streamline data analysis, Signal processing transformations, 2D FFT calculation in Python, Python data manipulation, Accurate data insights, Frequency analysis using 2D FFT] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Apply a 2D FFT function - - {App1} + GLink='TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT' + nodeLabel='TWO_DIMENSIONAL_FFT'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -62,10 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/SIGNAL_PROCESSING/TWO_DIMENSIONAL_FFT) \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/TEXT_CONCAT.md b/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/TEXT_CONCAT.md index 6b0f1b4e82..f3e1ef8b91 100644 --- a/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/TEXT_CONCAT.md +++ b/docs/nodes/TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT/TEXT_CONCAT.md @@ -1,51 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### Concatenate text strings +## Examples - {App1} + GLink='TRANSFORMERS/TEXT_MANIPULATION/TEXT_CONCAT' + nodeLabel='TEXT_CONCAT'> - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - + diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/DF_2_NP.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/DF_2_NP.md index bfbdfc0517..0095d55edb 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/DF_2_NP.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/DF_2_NP.md @@ -1,13 +1,9 @@ ---- -title: DF_2_NP -description: Easily convert Dataframes to NumPy arrays matrix type data using Python with Flojoy's DF_2_NP type casting transformer. -keyword: [Python, Transform, Type casting, Dataframe to NumPy conversion, Python type casting transformer, Data conversion with DF_2_NP, Python data manipulation, Streamline data processing, Data transformation techniques, NumPy array creation, Python data analysis, Accurate data insights, Data manipulation using DF_2_NP] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Convert a DataFrame to a Matrix - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/DF_2_NP' + nodeLabel='DF_2_NP'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_NP) diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/DF_2_ORDERED_TRIPLE.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/DF_2_ORDERED_TRIPLE.md index 2a6bda0336..bf94c64fab 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/DF_2_ORDERED_TRIPLE.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE/DF_2_ORDERED_TRIPLE.md @@ -1,13 +1,9 @@ ---- -title: DF_2_ORDEREDTRIPLE -description: Efficiently convert Dataframes to ordered triples using Python with Flojoy's DF_2_ORDEREDTRIPLE type casting transformer. It takes one dataframe type data to picks 3 different columns to generate OrderedTriple type. -keyword: [Python, Transform, Type casting, Dataframe to ordered triple conversion, Python type casting transformer, Data conversion with DF_2_ORDEREDTRIPLE, Python data manipulation, Streamline data processing, Data transformation techniques, Ordered triple creation, Python data analysis, Accurate data insights, Data manipulation using DF_2_ORDEREDTRIPLE] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDEREDTRIPLE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Convert a DataFrame to an OrderedTriple - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE' + nodeLabel='DF_2_ORDERED_TRIPLE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/DF_2_ORDERED_TRIPLE) diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/MAT_2_DF.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/MAT_2_DF.md index c1b8fcaec2..f21722679e 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/MAT_2_DF.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/MAT_2_DF.md @@ -1,13 +1,9 @@ ---- -title: MAT_2_DF -description: Efficiently convert matrices to Dataframes using Python with Flojoy's MAT_2_DF type casting transformer node. -keyword: [Python, Transform, Type casting, Matrix to DataFrame conversion, Python type casting transformer, Data conversion with MAT_2_DF, Python data manipulation, Streamline data processing, Data transformation techniques, DataFrame creation from matrix, Python data analysis, Accurate data insights, Data manipulation using MAT_2_DF] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Convert a Matrix to a DataFrame - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/MAT_2_DF' + nodeLabel='MAT_2_DF'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/MAT_2_DF) diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/NP_2_DF.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/NP_2_DF.md index e66ac03a57..92de40461a 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/NP_2_DF.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/NP_2_DF.md @@ -1,13 +1,9 @@ ---- -title: NP_2_DF -description: Swiftly convert NumPy arrays to Dataframes using Python with Flojoy's NP_2_DF type casting transformer. Simplify data processing for analysis. -keyword: [Python, Transform, Type casting, NumPy array to DataFrame conversion, Python type casting transformer, Data conversion with NP_2_DF, Python data manipulation, Streamline data processing, Data transformation techniques, DataFrame creation from NumPy array, Python data analysis, Accurate data insights, Data manipulation using NP_2_DF] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Convert a Numpy array to a DataFrame - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/NP_2_DF' + nodeLabel='NP_2_DF'> - + - + [//]: # (Appendix) -## Appendix - import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/NP_2_DF) diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/ORDERED_TRIPLE_2_SURFACE.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/ORDERED_TRIPLE_2_SURFACE.md index 69774f8cfb..0361f9e62b 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/ORDERED_TRIPLE_2_SURFACE.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/ORDERED_TRIPLE_2_SURFACE.md @@ -1,13 +1,9 @@ ---- -title: ORDERED_TRIPLE_2_SURFACE -description: Efficiently convert ordered triples to surfaces using Python with Flojoy's ORDERED_TRIPLE_2_SURFACE type casting transformer. It reshapes the z array into a 2D grid using the unique values of x and y. -keyword: [Python, Transform, Type casting, Ordered triple to surface conversion, Python type casting transformer, Data conversion with ORDERED_TRIPLE_2_SURFACE, Python data manipulation, Streamline data processing, Data transformation techniques, Surface creation from ordered triples, Python data analysis, Accurate data insights, Data manipulation using ORDERED_TRIPLE_2_SURFACE] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Convert an OrderedTriple to a Surface DataContainer - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE' + nodeLabel='ORDERED_TRIPLE_2_SURFACE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_TRIPLE_2_SURFACE) diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/VECTOR_2_ORDERED_PAIR.md b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/VECTOR_2_ORDERED_PAIR.md index c31fc2e9c6..b70ad4bfb9 100644 --- a/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/VECTOR_2_ORDERED_PAIR.md +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR/VECTOR_2_ORDERED_PAIR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate an OrderedPair from two vectors - - {App1} + GLink='TRANSFORMERS/TYPE_CASTING/VECTOR_2_ORDERED_PAIR' + nodeLabel='VECTOR_2_ORDERED_PAIR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/DECIMATE_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/DECIMATE_VECTOR.md index 322ac93d75..6855b46c7b 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/DECIMATE_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR/DECIMATE_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generate a decimated vector - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/DECIMATE_VECTOR' + nodeLabel='DECIMATE_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/INTERLEAVE_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/INTERLEAVE_VECTOR.md index 4337bca000..79f35f56a5 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/INTERLEAVE_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR/INTERLEAVE_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Combine different vectors into a single vector - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/INTERLEAVE_VECTOR' + nodeLabel='INTERLEAVE_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/REMOVE_DUPLICATES_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/REMOVE_DUPLICATES_VECTOR.md index ce1c5682c7..1c8bbc7a14 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/REMOVE_DUPLICATES_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR/REMOVE_DUPLICATES_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Generage a vector with only unique elements - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/REMOVE_DUPLICATES_VECTOR' + nodeLabel='REMOVE_DUPLICATES_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/REPLACE_SUBSET.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/REPLACE_SUBSET.md index 23ff946a65..dff79f2aa6 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/REPLACE_SUBSET.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET/REPLACE_SUBSET.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### REPLACE_SUBSET example - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/REPLACE_SUBSET' + nodeLabel='REPLACE_SUBSET'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/REVERSE_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/REVERSE_VECTOR.md index 1c84e691e7..4b9063676e 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/REVERSE_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR/REVERSE_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Reverse the elements of a vector - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/REVERSE_VECTOR' + nodeLabel='REVERSE_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/SHIFT_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/SHIFT_VECTOR.md index 37198943c1..2c6897322d 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/SHIFT_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR/SHIFT_VECTOR.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### SHIFT_VECTOR example - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/SHIFT_VECTOR' + nodeLabel='SHIFT_VECTOR'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/SHUFFLE_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/SHUFFLE_VECTOR.md index 219d71d1e3..912b540384 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/SHUFFLE_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR/SHUFFLE_VECTOR.md @@ -1,51 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### Randomly shuffle the elements of a vector +## Examples - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/SHUFFLE_VECTOR' + nodeLabel='SHUFFLE_VECTOR'> - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/SORT_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/SORT_VECTOR.md index 21bcd6180e..86b55a6dae 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/SORT_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR/SORT_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Sort a vector in ascending order - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/SORT_VECTOR' + nodeLabel='SORT_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/SPLIT_VECTOR.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/SPLIT_VECTOR.md index 48a8685a6d..876aa454b0 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/SPLIT_VECTOR.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR/SPLIT_VECTOR.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Split a vector into two different vectors - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/SPLIT_VECTOR' + nodeLabel='SPLIT_VECTOR'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/VECTOR_DELETE.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/VECTOR_DELETE.md index e29bcdb479..5289159b20 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/VECTOR_DELETE.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE/VECTOR_DELETE.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### VECTOR_DELETE example - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_DELETE' + nodeLabel='VECTOR_DELETE'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/VECTOR_INDEXING.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/VECTOR_INDEXING.md index 69b4e3e34f..fac7de8cd6 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/VECTOR_INDEXING.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING/VECTOR_INDEXING.md @@ -1,51 +1,42 @@ - -[//]: # 'Custom component imports' +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### Extract the value of a Vector at a specific index +## Examples - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INDEXING' + nodeLabel='VECTOR_INDEXING'> - - -[//]: # 'Appendix' + + +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/VECTOR_INSERT.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/VECTOR_INSERT.md index 7d12c586eb..204b8c65aa 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/VECTOR_INSERT.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT/VECTOR_INSERT.md @@ -2,6 +2,8 @@ [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -10,9 +12,11 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} @@ -23,29 +27,13 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### VECTOR_INSERT example - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_INSERT' + nodeLabel='VECTOR_INSERT'> - - - + [//]: # (Appendix) diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/VECTOR_LENGTH.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/VECTOR_LENGTH.md index 7aeda58106..704474ecc2 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/VECTOR_LENGTH.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH/VECTOR_LENGTH.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,39 +12,29 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Extract the length of a Vector - - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_LENGTH' + nodeLabel='VECTOR_LENGTH'> - + - + [//]: # (Appendix) @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/VECTOR_MAX.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/VECTOR_MAX.md index d99d41c589..e24b260a0b 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/VECTOR_MAX.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX/VECTOR_MAX.md @@ -1,51 +1,42 @@ -[//]: # 'Custom component imports' + +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### VECTOR_MAX example +## Examples - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MAX' + nodeLabel='VECTOR_MAX'> - - - + -[//]: # 'Appendix' +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -56,3 +47,5 @@ import Media from './appendix/media.md'; + + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/VECTOR_MIN.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/VECTOR_MIN.md index 57fd2c3b96..0f81920016 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/VECTOR_MIN.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN/VECTOR_MIN.md @@ -1,51 +1,42 @@ -[//]: # 'Custom component imports' + +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### VECTOR_MIN example +## Examples - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_MIN' + nodeLabel='VECTOR_MIN'> - - - + -[//]: # 'Appendix' +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -56,3 +47,5 @@ import Media from './appendix/media.md'; + + diff --git a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/VECTOR_SUBSET.md b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/VECTOR_SUBSET.md index 4f4bd12d45..c8c40608be 100644 --- a/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/VECTOR_SUBSET.md +++ b/docs/nodes/TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET/VECTOR_SUBSET.md @@ -1,50 +1,42 @@ -[//]: # 'Custom component imports' + +[//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; import AppendixSection from '@site/src/components/AppendixSection'; -[//]: # 'Docstring' +[//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} -[//]: # 'Examples' - -## Examples + -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' +[//]: # (Examples) -### VECTOR_SUBSET example +## Examples - {App1} + GLink='TRANSFORMERS/VECTOR_MANIPULATION/VECTOR_SUBSET' + nodeLabel='VECTOR_SUBSET'> - - + -[//]: # 'Appendix' +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; @@ -55,3 +47,5 @@ import Media from './appendix/media.md'; + + diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/ARRAY_VIEW.md b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/ARRAY_VIEW.md index a867c58a38..d969e6d376 100644 --- a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/ARRAY_VIEW.md +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/ARRAY_VIEW.md @@ -1,13 +1,9 @@ ---- -title: ARRAY_VIEW -description: The ARRAY_VIEW node takes ordered_pair, dataframe, matrix, and image as input type and displays its visualization in array format. -keywords: [Python, Visualize, Array View visualizer, Data structure visualization, Array representation tools, Flojoy visualization nodes, Array View examples, Array data visualization, Visualizing data arrays, Data structure illustration, Array visualization techniques, Data array exploration] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Visualize a DataContainer as an array - - {App1} + GLink='VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW' + nodeLabel='ARRAY_VIEW'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/DATA_STRUCTURE/ARRAY_VIEW) diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.md b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.md index 4a4fabfc71..ecee63b5cb 100644 --- a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.md +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/MATRIX_VIEW.md @@ -1,13 +1,9 @@ ---- -title: MATRIX_VIEW -description: The MATRIX_VIEW node "matrix" or "ordered_pair" type as input type and displays its visualization using plotly table in matrix format. -keywords: [Python, Visualize, Plotly, Matrix View visualizer, Data structure visualization, Matrix representation tools, Flojoy visualization nodes, Matrix View examples, Matrix data visualization, Visualizing data matrices, Data structure illustration, Matrix visualization techniques, Data matrix exploration] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Visualize a DataContainer as a Plotly Matrix - - {App1} + GLink='VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW' + nodeLabel='MATRIX_VIEW'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/DATA_STRUCTURE/MATRIX_VIEW) diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/TEXT_VIEW.md b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/TEXT_VIEW.md index 2f36fb38d3..4fa8004db0 100644 --- a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/TEXT_VIEW.md +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/TEXT_VIEW.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,19 +12,21 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -### Visualize a TextBlob DataContainer as text - @@ -31,6 +34,8 @@ import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -43,12 +48,4 @@ import Media from './appendix/media.md'; - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub - -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW) - diff --git a/docs/nodes/VISUALIZERS/PLOTLY/BAR/BAR.md b/docs/nodes/VISUALIZERS/PLOTLY/BAR/BAR.md index 6d85f3d67e..2dfd37d840 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/BAR/BAR.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/BAR/BAR.md @@ -1,13 +1,9 @@ ---- -title: BAR -description: Elevate your data visualization with Python using Flojoy's Plotly Bar visualizer. Create dynamic bar plots for insightful presentations and analyses. -keywords: [Python, Visualize, Plotly, Plotly Bar visualizer, Python bar chart tool, Dynamic data visualization, Bar plot examples, Flojoy Plotly nodes, Interactive bar charts, Data presentation tools, Python data visualization, Bar chart creation, Visualizing data with Plotly] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/BAR/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Bar visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/BAR' + nodeLabel='BAR'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/BAR) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/BIG_NUMBER.md b/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/BIG_NUMBER.md index 7e24905b4d..6fc0137054 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/BIG_NUMBER.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/BIG_NUMBER.md @@ -1,13 +1,9 @@ ---- -title: BIG_NUMBER -description: Enhance data presentation using Python with Flojoy's Plotly Big Number visualizer. Create impactful visualizations for large numerical insights. -keywords: [Python, Visualize, Plotly, Plotly Big Number visualizer, Python numerical visualization, Large numerical insights, Big Number visualization examples, Flojoy Plotly nodes, Data presentation tools, Python data visualization, Numerical data representation, Visualizing data with Plotly, Impactful numerical insights] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Big Number visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/BIG_NUMBER' + nodeLabel='BIG_NUMBER'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/BIG_NUMBER) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/COMPOSITE.md b/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/COMPOSITE.md index 37a2696ed1..4b7e62e855 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/COMPOSITE.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/COMPOSITE.md @@ -1,13 +1,9 @@ ---- -title: COMPOSITE -description: The COMPOSITE node creates a combination of Plotly visualizations for a given input data container. -keywords: [Python, Visualize, Plotly, Plotly Composite visualizer, Composite data visualization, Data fusion using Plotly, Composite plot examples, Flojoy Plotly nodes, Multi-dimensional data visualization, Python composite data representation, Visualizing complex data, Plotly for composite insights, Interactive composite visualization] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,62 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a combination of Plotly visualizations - - {App1} + GLink='VISUALIZERS/PLOTLY/COMPOSITE' + nodeLabel='COMPOSITE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; -<<<<<<< HEAD - - - -======= +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/COMPOSITE) ->>>>>>> d898a0e0 (feat: Concluded adding unique links to GitHub Edit page sources.) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/HEATMAP.md b/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/HEATMAP.md index 14048f4fc5..9d05dddbc2 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/HEATMAP.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/HEATMAP/HEATMAP.md @@ -1,8 +1,9 @@ - [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -11,40 +12,30 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Heatmap visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/HEATMAP' + nodeLabel='HEATMAP'> - - + + [//]: # (Appendix) import Notes from './appendix/notes.md'; @@ -57,4 +48,4 @@ import Media from './appendix/media.md'; - \ No newline at end of file + diff --git a/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/HISTOGRAM.md b/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/HISTOGRAM.md index 2a978cede2..dc4f482878 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/HISTOGRAM.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/HISTOGRAM.md @@ -1,13 +1,9 @@ ---- -title: HISTOGRAM -description: The HISTOGRAM node creates a Plotly Histogram visualization for a given input data container. -keywords: [Python, Visualize, Plotly, Plotly Histogram visualizer, Python histogram chart, Data distribution visualization, Histogram plot examples, Flojoy Plotly nodes, Interactive data visualization, Python data analysis tools, Histogram representation, Visualizing data with Plotly, Data distribution insights] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,62 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Histogram visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/HISTOGRAM' + nodeLabel='HISTOGRAM'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; -<<<<<<< HEAD - - - -======= +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/HISTOGRAM) ->>>>>>> d898a0e0 (feat: Concluded adding unique links to GitHub Edit page sources.) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/IMAGE.md b/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/IMAGE.md index dd85f3548e..71ec241630 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/IMAGE.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/IMAGE.md @@ -1,13 +1,9 @@ ---- -title: IMAGE -description: The IMAGE node creates a Plotly image visualization for a given input data container type of image. -keywords: [Python, Visualize, Plotly, Plotly Image visualizer, Python image data visualization, Visualizing images with Plotly, Image plot examples, Flojoy Plotly nodes, Interactive image visualization, Python data visualization tools, Image representation techniques, Plotly for image insights, Image data exploration] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/IMAGE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Image visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/IMAGE' + nodeLabel='IMAGE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/IMAGE) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/LINE/LINE.md b/docs/nodes/VISUALIZERS/PLOTLY/LINE/LINE.md index 1586c7defd..8700d5d78e 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/LINE/LINE.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/LINE/LINE.md @@ -1,13 +1,9 @@ ---- -title: LINE -description: The LINE node creates a Plotly Line visualization for a given input data container. -keywords: [Python, Visualize, Plotly, Plotly Line visualizer, Python line chart tool, Data trend visualization, Line plot examples, Flojoy Plotly nodes, Interactive line charts, Python data visualization, Line chart creation, Visualizing data with Plotly, Data trend analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/LINE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Line visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/LINE' + nodeLabel='LINE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/LINE) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/PROPHET_COMPONENTS.md b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/PROPHET_COMPONENTS.md index 99b67e3e70..3e68a896ce 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/PROPHET_COMPONENTS.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/PROPHET_COMPONENTS.md @@ -1,13 +1,9 @@ ---- -title: PROPHET_COMPONENTS -description: Explore Python-powered Prophet components visualization in Flojoy. Master dynamic insights into time series forecasting components. -keywords: [Python, Visualize, Plotly, Plotly Prophet Components visualizer, Python time series visualization, Dynamic Prophet components insight, Plotly time series plot examples, Flojoy Plotly nodes, Interactive time series visualization, Python data visualization tools, Time series components representation, Visualizing Prophet components with Plotly, Time series analysis using Prophet] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Visualize the components of a Prophet model - - {App1} + GLink='VISUALIZERS/PLOTLY/PROPHET_COMPONENTS' + nodeLabel='PROPHET_COMPONENTS'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/PROPHET_PLOT.md b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/PROPHET_PLOT.md index c16c6bab2c..ac1b5da4d4 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/PROPHET_PLOT.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/PROPHET_PLOT.md @@ -1,13 +1,9 @@ ---- -title: PROPHET_PLOT -description: Enhance time series insights with Python using Flojoy's Prophet Plot visualizer. Master dynamic visualization of Prophet model predictions and trends. -keywords: [Python, Visualize, Plotly, Plotly Prophet Plot visualizer, Python time series visualization, Dynamic Prophet model insights, Plotly time series plot examples, Flojoy Plotly nodes, Interactive time series visualization, Python data visualization tools, Visualizing Prophet predictions, Time series analysis using Plotly, Prophet model visualization] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Visualize the forecasted trend of time series data - - {App1} + GLink='VISUALIZERS/PLOTLY/PROPHET_PLOT' + nodeLabel='PROPHET_PLOT'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/SCATTER.md b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/SCATTER.md index d7ff3b8e75..4082a1a7c2 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/SCATTER.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/SCATTER.md @@ -1,13 +1,9 @@ ---- -title: SCATTER -description: Elevate data visualization with Python using Flojoy's Scatter visualizer. Create dynamic scatter plots for insightful analyses and presentations. -keywords: [Python, Visualize, Plotly, Plotly Scatter visualizer, Python scatter plot tool, Data point visualization, Scatter plot examples, Flojoy Plotly nodes, Interactive scatter charts, Python data visualization, Scatter plot creation, Visualizing data with Plotly, Data point analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/SCATTER/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Scatter visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/SCATTER' + nodeLabel='SCATTER'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/SCATTER) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/SCATTER3D.md b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/SCATTER3D.md index 6d2ed14b6d..b208955a24 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/SCATTER3D.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/SCATTER3D.md @@ -1,13 +1,9 @@ ---- -title: SCATTER3D -description: Enhance data visualization with Python using Flojoy's Scatter3D visualizer. Create dynamic 3D scatter plots for insightful analyses and presentations. -keywords: [Python, Visualize, Plotly, 3D, Plotly Scatter3D visualizer, Python 3D scatter plot tool, Three-dimensional data visualization, Scatter3D plot examples, Flojoy Plotly nodes, Interactive 3D scatter charts, Python data visualization, 3D scatter plot creation, Visualizing data with Plotly, Three-dimensional data analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly 3D Scatter visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/SCATTER3D' + nodeLabel='SCATTER3D'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/SCATTER3D) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.md b/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.md index 1f9658156f..3eaf155b41 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/SURFACE3D.md @@ -1,13 +1,9 @@ ---- -title: SURFACE3D -description: The SURFACE3D node creates a Plotly 3D Surface visualization for a given input DataContainer. -keywords: [Python, Visualize, Plotly, 3D, Plotly Surface3D visualizer, Python 3D surface plot tool, Three-dimensional data visualization, Surface3D plot examples, Flojoy Plotly nodes, Interactive 3D surface charts, Python data visualization, 3D surface plot creation, Visualizing data with Plotly, Three-dimensional data analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly 3d Surface visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/SURFACE3D' + nodeLabel='SURFACE3D'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/SURFACE3D) \ No newline at end of file diff --git a/docs/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.md b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.md index 03fbfd666f..f9a85e77fb 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.md +++ b/docs/nodes/VISUALIZERS/PLOTLY/TABLE/TABLE.md @@ -1,13 +1,9 @@ ---- -title: TABLE -description: Enhance data presentation with Python using Flojoy's Plotly Table visualizer. Create dynamic tables for organized and insightful data representation. -keywords: [Python, Visualize, Plotly, Plotly Table visualizer, Python data table tool, Dynamic table creation, Table visualization examples, Flojoy Plotly nodes, Interactive data tables, Python data representation, Table creation with Plotly, Visualizing data with tables, Data table analysis] -image: https://raw.githubusercontent.com/flojoy-ai/docs/main/docs/nodes/VISUALIZERS/PLOTLY/TABLE/examples/EX1/output.jpeg ---- [//]: # (Custom component imports) import DocString from '@site/src/components/DocString'; +import DocStringJSON from '@site/src/components/DocStringJSON'; + import PythonCode from '@site/src/components/PythonCode'; import AppDisplay from '@site/src/components/AppDisplay'; import SectionBreak from '@site/src/components/SectionBreak'; @@ -16,56 +12,40 @@ import AppendixSection from '@site/src/components/AppendixSection'; [//]: # (Docstring) import DocstringSource from '!!raw-loader!./a1-[autogen]/docstring.txt'; +import DocstringJson from '!!raw-loader!./a1-[autogen]/docstring.json'; import PythonSource from '!!raw-loader!./a1-[autogen]/python_code.txt'; {DocstringSource} + {PythonSource} + + [//]: # (Examples) ## Examples -import Example1 from './examples/EX1/example.md'; -import App1 from '!!raw-loader!./examples/EX1/app.json'; -import appImg from './examples/EX1/app.jpeg' -import appImgLight from './examples/EX1/app_light.jpeg' -import outputImg from './examples/EX1/output.jpeg' -import outputLight from './examples/EX1/output_light.jpeg' - -### Create a Plotly Table visualization - - {App1} + GLink='VISUALIZERS/PLOTLY/TABLE' + nodeLabel='TABLE'> - - -[//]: # (Appendix) + -## Appendix +[//]: # (Appendix) import Notes from './appendix/notes.md'; import Hardware from './appendix/hardware.md'; import Media from './appendix/media.md'; +## Appendix + - - -[//]: # (Edit page on GitHub) - -#### Edit this page on GitHub -[Edit page here](https://github.com/flojoy-ai/docs/tree/main/docs/nodes/VISUALIZERS/PLOTLY/TABLE) \ No newline at end of file