Virtualitics SDK Documentation¶
Example Flows¶
Please see our set of Flow Building Walkthroughs to see some example usage of Predict Flows.
Contents:
- virtualitics_sdk
- assets
- asset
- dataset
- explainer
Explainer
Explainer.check_lime_usage_()
Explainer.check_shap_usage_()
Explainer.explain()
Explainer.filter_features()
Explainer.get_data_likelihood()
Explainer.get_feature_explanation()
Explainer.get_instance_hash()
Explainer.get_lime_explanation()
Explainer.get_shap_explanation()
Explainer.get_text_explanation()
Explainer.get_waterfall_explanation()
Explainer.initialize_dataset_model_stats()
Explainer.initialize_encodings()
Explainer.initialize_explainer_lime()
Explainer.initialize_explainer_shap()
Explainer.initialize_explainers()
Explainer.initialize_explanation_mode()
Explainer.initialize_model()
Explainer.initialize_output_names()
Explainer.lime_target_func()
Explainer.make_model_regressor()
Explainer.model_preprocess()
Explainer.pick_instance()
Explainer.plot_waterfall_instance()
Explainer.replace_dataset()
Explainer.shap_target_func()
Explainer.show_significant_vars()
Explainer.smart_instance_selection()
Explainer.train_data_likelihood_model()
ExplainerReturnTypes
ExplanationTypes
InstanceSelectionMethod
InstanceSet
NLPExplanationMethod
- knowledge_graph
- language_processor
LanguageProcessor
LanguageProcessor.DATASET_UUID
LanguageProcessor.available_models
LanguageProcessor.available_tasks()
LanguageProcessor.entities2features()
LanguageProcessor.events2features()
LanguageProcessor.get_doc_ids_and_dates()
LanguageProcessor.get_doc_nlp_features()
LanguageProcessor.get_doc_node_attributes()
LanguageProcessor.get_doc_numbers()
LanguageProcessor.get_single_doc_nlp_features()
LanguageProcessor.get_table()
LanguageProcessor.ingest()
LanguageProcessor.initialize_model()
counter_to_str_repr()
- model
- schema
- elements
- asset_selection
- custom_event
- dashboard
- data_source
- date_time_range
- dropdown
- dropdown_data_sources
- element
Element
ElementType
ElementType.ASSET_SELECTION
ElementType.CUSTOM_EVENT
ElementType.DASHBOARD
ElementType.DATA_SOURCE
ElementType.DATE_TIME_RANGE
ElementType.DROPDOWN
ElementType.FILTERS
ElementType.IMAGE
ElementType.INFOGRAPHIC
ElementType.INPUT
ElementType.NUMERIC_RANGE
ElementType.PLOT
ElementType.RICH_TEXT
ElementType.TABLE
ElementType.TEXT_INPUT
ElementType.XAI_DASHBOARD
InputElement
- image
- infograph
- line
- numeric_range
- plot
Plot
PlotAxisScale
PlotAxisScale.AUTO
PlotAxisScale.BAND
PlotAxisScale.IDENTITY
PlotAxisScale.LINEAR
PlotAxisScale.LOGARITHMIC
PlotAxisScale.ORDINAL
PlotAxisScale.POINT
PlotAxisScale.POW
PlotAxisScale.QUANTILE
PlotAxisScale.QUANTIZE
PlotAxisScale.SEQUENTIAL
PlotAxisScale.SQUARE_ROOT
PlotAxisScale.THRESHOLD
PlotAxisScale.TIME
PlotAxisScale.UTC
PlotAxisType
PlotDataKey
PlotDataPoint
PlotDataType
PlotOrientation
PlotType
TooltipStatus
XAxis
XAxisOrientation
YAxis
YAxisOrientation
- plotly_plot
- rich_text
- table
- text_input
- waterfall_plot
- xai_button
- xai_dashboard
- exceptions
- flow
- icons
- nlp
- advanced
KGAdvancedConfig
KGAdvancedConfig.alpha_value_drop_title
KGAdvancedConfig.bonferroni_drop_title
KGAdvancedConfig.create_significant_feature_card()
KGAdvancedConfig.create_sim_thresh_config_drop()
KGAdvancedConfig.get_alpha_value_or_default()
KGAdvancedConfig.get_bonferroni_value_or_default()
KGAdvancedConfig.get_sim_threshold_range_or_default()
KGAdvancedConfig.get_sim_threshold_value_or_default()
KGAdvancedConfig.main_section
KGAdvancedConfig.run()
KGAdvancedConfig.sim_threshold_drop_range
KGAdvancedConfig.sim_threshold_drop_title
KGAdvancedConfig.step_title
- analytics
- common
- data_upload
DataUpload
DataUpload.corpus_name_textinput_placeholder
DataUpload.corpus_name_textinput_title
DataUpload.corpus_requirements
DataUpload.data_source_title
DataUpload.get_corpus_name()
DataUpload.get_model_or_default()
DataUpload.main_section
DataUpload.model_selection_default
DataUpload.model_selection_title
DataUpload.run()
DataUpload.step_title
- feature_analytics
- ingestion
DataDiagnostic
DateTimeFiltering
create_average_dep_depth_hist()
doc_len_infographic()
empty_docs_infographic()
events_entities_infographics()
generate_pos_summary_df()
mean_dependency_tree_depth()
mean_sents_info()
mean_unique_words()
sent_len_infographic()
unique_ents_features_in_corpus()
unique_events_features_in_corpus()
- network_extraction
- pipeline_config
NoDatasetIdxException
PipelineConfigurationStep
PipelineConfigurationStep.available_tasks_drop_title
PipelineConfigurationStep.create_date_filtering_components()
PipelineConfigurationStep.create_feature_selection_card()
PipelineConfigurationStep.create_pipeline_config_drop()
PipelineConfigurationStep.default_pipeline_tasks
PipelineConfigurationStep.dt_dropdown_title
PipelineConfigurationStep.dt_format_input
PipelineConfigurationStep.get_idx()
PipelineConfigurationStep.get_pipe_config_or_default()
PipelineConfigurationStep.identifier_dropdown_title
PipelineConfigurationStep.kpi_dropdown_title
PipelineConfigurationStep.narrative_dropdown_title
PipelineConfigurationStep.run()
PipelineConfigurationStep.step_title
- sim_thresh
- advanced
- page
- card
- page
Page
Page.activate()
Page.add_card_to_section()
Page.add_content_to_section()
Page.elements
Page.get_card_by_id()
Page.get_card_by_title()
Page.get_element_by_id()
Page.get_element_by_title()
Page.get_section_by_title()
Page.has_required_input
Page.remove_card()
Page.replace_content_in_section()
Page.save()
Page.sections
Page.serialize()
Page.update_card_title()
PageType
- section
- store
- store_interface
StoreInterface
StoreInterface.create_element_link()
StoreInterface.create_future_element()
StoreInterface.db_to_pandas()
StoreInterface.get_asset()
StoreInterface.get_asset_by_id()
StoreInterface.get_assets()
StoreInterface.get_boto3_s3_client_from_connection_store()
StoreInterface.get_current_step_user_input()
StoreInterface.get_dataset()
StoreInterface.get_element()
StoreInterface.get_element_by_id()
StoreInterface.get_element_value()
StoreInterface.get_explainer()
StoreInterface.get_flow_status()
StoreInterface.get_input()
StoreInterface.get_model()
StoreInterface.get_page()
StoreInterface.get_previous_step_name()
StoreInterface.get_raw_data_source_data()
StoreInterface.get_s3_asset()
StoreInterface.get_schema()
StoreInterface.has_input()
StoreInterface.list_fixture_data()
StoreInterface.pandas_to_db()
StoreInterface.save_asset()
StoreInterface.save_output()
StoreInterface.str_2_connection_type()
StoreInterface.update_page()
StoreInterface.update_progress()
- store_interface
- trigger
- utils
- assets