Merge remote-tracking branch 'upstream/hotfixes' into release

docs/source/api.rst

@@ -402,3 +402,282 @@ Other algorithms, which do not belong to the aforementioned categories, are coll
   * :meth:`pm4py.analysis.reduce_petri_net_invisibles`; reduces the invisible transitions of a Petri net when possible.
   * :meth:`pm4py.analysis.reduce_petri_net_implicit_places`; reduces the implicit places in the Petri net (using MURATA).
   * :meth:`pm4py.analysis.get_enabled_transitions`; gets the transitions enabled in a given marking.
+
+
+
+
+List of Methods
+------------------------------------------
+
+.. autosummary::
+   :toctree: generated
+
+   pm4py.read
+   pm4py.read.read_bpmn
+   pm4py.read.read_dfg
+   pm4py.read.read_pnml
+   pm4py.read.read_ptml
+   pm4py.read.read_xes
+   pm4py.read.read_ocel_csv
+   pm4py.read.read_ocel_jsonocel
+   pm4py.read.read_ocel_xmlocel
+   pm4py.read.read_ocel_sqlite
+   pm4py.read.read_ocel2_xml
+   pm4py.read.read_ocel2_sqlite
+   pm4py.read.read_ocel2_json
+   pm4py.write
+   pm4py.write.write_bpmn
+   pm4py.write.write_dfg
+   pm4py.write.write_pnml
+   pm4py.write.write_ptml
+   pm4py.write.write_xes
+   pm4py.write.write_ocel_csv
+   pm4py.write.write_ocel_jsonocel
+   pm4py.write.write_ocel_xmlocel
+   pm4py.write.write_ocel_sqlite
+   pm4py.write.write_ocel2_xml
+   pm4py.write.write_ocel2_sqlite
+   pm4py.write.write_ocel2_json
+   pm4py.convert
+   pm4py.convert.convert_to_event_log
+   pm4py.convert.convert_to_event_stream
+   pm4py.convert.convert_to_dataframe
+   pm4py.convert.convert_to_bpmn
+   pm4py.convert.convert_to_petri_net
+   pm4py.convert.convert_to_process_tree
+   pm4py.convert.convert_to_reachability_graph
+   pm4py.convert.convert_log_to_ocel
+   pm4py.convert.convert_log_to_networkx
+   pm4py.convert.convert_ocel_to_networkx
+   pm4py.convert.convert_petri_net_to_networkx
+   pm4py.convert.convert_petri_net_type
+   pm4py.discovery
+   pm4py.discovery.discover_dfg
+   pm4py.discovery.discover_performance_dfg
+   pm4py.discovery.discover_petri_net_alpha
+   pm4py.discovery.discover_petri_net_inductive
+   pm4py.discovery.discover_petri_net_heuristics
+   pm4py.discovery.discover_petri_net_ilp
+   pm4py.discovery.discover_process_tree_inductive
+   pm4py.discovery.discover_heuristics_net
+   pm4py.discovery.derive_minimum_self_distance
+   pm4py.discovery.discover_footprints
+   pm4py.discovery.discover_eventually_follows_graph
+   pm4py.discovery.discover_bpmn_inductive
+   pm4py.discovery.discover_transition_system
+   pm4py.discovery.discover_prefix_tree
+   pm4py.discovery.discover_temporal_profile
+   pm4py.discovery.discover_declare
+   pm4py.discovery.discover_log_skeleton
+   pm4py.discovery.discover_batches
+   pm4py.discovery.discover_powl
+   pm4py.conformance
+   pm4py.conformance.conformance_diagnostics_token_based_replay
+   pm4py.conformance.conformance_diagnostics_alignments
+   pm4py.conformance.conformance_diagnostics_footprints
+   pm4py.conformance.fitness_token_based_replay
+   pm4py.conformance.fitness_alignments
+   pm4py.conformance.fitness_footprints
+   pm4py.conformance.precision_token_based_replay
+   pm4py.conformance.precision_alignments
+   pm4py.conformance.precision_footprints
+   pm4py.conformance.replay_prefix_tbr
+   pm4py.conformance.conformance_temporal_profile
+   pm4py.conformance.conformance_declare
+   pm4py.conformance.conformance_log_skeleton
+   pm4py.vis
+   pm4py.vis.view_petri_net
+   pm4py.vis.save_vis_petri_net
+   pm4py.vis.view_performance_dfg
+   pm4py.vis.save_vis_performance_dfg
+   pm4py.vis.view_dfg
+   pm4py.vis.save_vis_dfg
+   pm4py.vis.view_process_tree
+   pm4py.vis.save_vis_process_tree
+   pm4py.vis.view_bpmn
+   pm4py.vis.save_vis_bpmn
+   pm4py.vis.view_heuristics_net
+   pm4py.vis.save_vis_heuristics_net
+   pm4py.vis.view_dotted_chart
+   pm4py.vis.save_vis_dotted_chart
+   pm4py.vis.view_sna
+   pm4py.vis.save_vis_sna
+   pm4py.vis.view_case_duration_graph
+   pm4py.vis.save_vis_case_duration_graph
+   pm4py.vis.view_events_per_time_graph
+   pm4py.vis.save_vis_events_per_time_graph
+   pm4py.vis.view_performance_spectrum
+   pm4py.vis.save_vis_performance_spectrum
+   pm4py.vis.view_events_distribution_graph
+   pm4py.vis.save_vis_events_distribution_graph
+   pm4py.vis.view_ocdfg
+   pm4py.vis.save_vis_ocdfg
+   pm4py.vis.view_ocpn
+   pm4py.vis.save_vis_ocpn
+   pm4py.vis.view_object_graph
+   pm4py.vis.save_vis_object_graph
+   pm4py.vis.view_network_analysis
+   pm4py.vis.save_vis_network_analysis
+   pm4py.vis.view_transition_system
+   pm4py.vis.save_vis_transition_system
+   pm4py.vis.view_prefix_tree
+   pm4py.vis.save_vis_prefix_tree
+   pm4py.vis.view_alignments
+   pm4py.vis.save_vis_alignments
+   pm4py.vis.view_footprints
+   pm4py.vis.save_vis_footprints
+   pm4py.vis.view_powl
+   pm4py.vis.save_vis_powl
+   pm4py.stats
+   pm4py.stats.get_start_activities
+   pm4py.stats.get_end_activities
+   pm4py.stats.get_event_attributes
+   pm4py.stats.get_trace_attributes
+   pm4py.stats.get_event_attribute_values
+   pm4py.stats.get_trace_attribute_values
+   pm4py.stats.get_variants
+   pm4py.stats.get_variants_as_tuples
+   pm4py.stats.split_by_process_variant
+   pm4py.stats.get_variants_paths_duration
+   pm4py.stats.get_minimum_self_distances
+   pm4py.stats.get_minimum_self_distance_witnesses
+   pm4py.stats.get_case_arrival_average
+   pm4py.stats.get_rework_cases_per_activity
+   pm4py.stats.get_cycle_time
+   pm4py.stats.get_all_case_durations
+   pm4py.stats.get_case_duration
+   pm4py.stats.get_frequent_trace_segments
+   pm4py.stats.get_service_time
+   pm4py.stats.get_activity_position_summary
+   pm4py.stats.get_stochastic_language
+   pm4py.filtering
+   pm4py.filtering.filter_log_relative_occurrence_event_attribute
+   pm4py.filtering.filter_start_activities
+   pm4py.filtering.filter_end_activities
+   pm4py.filtering.filter_event_attribute_values
+   pm4py.filtering.filter_trace_attribute_values
+   pm4py.filtering.filter_variants
+   pm4py.filtering.filter_directly_follows_relation
+   pm4py.filtering.filter_eventually_follows_relation
+   pm4py.filtering.filter_time_range
+   pm4py.filtering.filter_between
+   pm4py.filtering.filter_case_size
+   pm4py.filtering.filter_case_performance
+   pm4py.filtering.filter_activities_rework
+   pm4py.filtering.filter_paths_performance
+   pm4py.filtering.filter_variants_top_k
+   pm4py.filtering.filter_variants_by_coverage_percentage
+   pm4py.filtering.filter_prefixes
+   pm4py.filtering.filter_suffixes
+   pm4py.filtering.filter_trace_segments
+   pm4py.filtering.filter_ocel_event_attribute
+   pm4py.filtering.filter_ocel_object_attribute
+   pm4py.filtering.filter_ocel_object_types_allowed_activities
+   pm4py.filtering.filter_ocel_object_per_type_count
+   pm4py.filtering.filter_ocel_start_events_per_object_type
+   pm4py.filtering.filter_ocel_end_events_per_object_type
+   pm4py.filtering.filter_ocel_events_timestamp
+   pm4py.filtering.filter_four_eyes_principle
+   pm4py.filtering.filter_activity_done_different_resources
+   pm4py.filtering.filter_ocel_object_types
+   pm4py.filtering.filter_ocel_events
+   pm4py.filtering.filter_ocel_objects
+   pm4py.filtering.filter_ocel_cc_object
+   pm4py.filtering.filter_ocel_cc_length
+   pm4py.filtering.filter_ocel_cc_otype
+   pm4py.filtering.filter_ocel_cc_activity
+   pm4py.ml
+   pm4py.ml.split_train_test
+   pm4py.ml.get_prefixes_from_log
+   pm4py.ml.extract_features_dataframe
+   pm4py.ml.extract_temporal_features_dataframe
+   pm4py.ml.extract_target_vector
+   pm4py.ml.extract_outcome_enriched_dataframe
+   pm4py.ml.extract_ocel_features
+   pm4py.sim
+   pm4py.sim.play_out
+   pm4py.sim.generate_process_tree
+   pm4py.ocel
+   pm4py.ocel.ocel_get_object_types
+   pm4py.ocel.ocel_get_attribute_names
+   pm4py.ocel.ocel_flattening
+   pm4py.ocel.ocel_object_type_activities
+   pm4py.ocel.ocel_objects_ot_count
+   pm4py.ocel.discover_ocdfg
+   pm4py.ocel.discover_oc_petri_net
+   pm4py.ocel.ocel_temporal_summary
+   pm4py.ocel.ocel_objects_summary
+   pm4py.ocel.ocel_objects_interactions_summary
+   pm4py.ocel.sample_ocel_objects
+   pm4py.ocel.sample_ocel_connected_components
+   pm4py.ocel.ocel_drop_duplicates
+   pm4py.ocel.ocel_merge_duplicates
+   pm4py.ocel.ocel_o2o_enrichment
+   pm4py.ocel.ocel_e2o_lifecycle_enrichment
+   pm4py.ocel.cluster_equivalent_ocel
+   pm4py.llm
+   pm4py.llm.abstract_dfg
+   pm4py.llm.abstract_variants
+   pm4py.llm.abstract_ocel
+   pm4py.llm.abstract_ocel_ocdfg
+   pm4py.llm.abstract_ocel_features
+   pm4py.llm.abstract_event_stream
+   pm4py.llm.abstract_petri_net
+   pm4py.llm.abstract_log_attributes
+   pm4py.llm.abstract_log_features
+   pm4py.llm.abstract_temporal_profile
+   pm4py.llm.abstract_case
+   pm4py.llm.abstract_declare
+   pm4py.llm.abstract_log_skeleton
+   pm4py.llm.openai_query
+   pm4py.llm.explain_visualization
+   pm4py.connectors.extract_log_outlook_mails
+   pm4py.connectors.extract_log_outlook_calendar
+   pm4py.connectors.extract_log_windows_events
+   pm4py.connectors.extract_log_chrome_history
+   pm4py.connectors.extract_log_firefox_history
+   pm4py.connectors.extract_log_github
+   pm4py.connectors.extract_log_camunda_workflow
+   pm4py.connectors.extract_log_sap_o2c
+   pm4py.connectors.extract_log_sap_accounting
+   pm4py.connectors.extract_ocel_outlook_mails
+   pm4py.connectors.extract_ocel_outlook_calendar
+   pm4py.connectors.extract_ocel_windows_events
+   pm4py.connectors.extract_ocel_chrome_history
+   pm4py.connectors.extract_ocel_firefox_history
+   pm4py.connectors.extract_ocel_github
+   pm4py.connectors.extract_ocel_camunda_workflow
+   pm4py.connectors.extract_ocel_sap_o2c
+   pm4py.connectors.extract_ocel_sap_accounting
+   pm4py.org
+   pm4py.org.discover_handover_of_work_network
+   pm4py.org.discover_working_together_network
+   pm4py.org.discover_activity_based_resource_similarity
+   pm4py.org.discover_subcontracting_network
+   pm4py.org.discover_organizational_roles
+   pm4py.org.discover_network_analysis
+   pm4py.analysis
+   pm4py.analysis.cluster_log
+   pm4py.analysis.insert_case_service_waiting_time
+   pm4py.analysis.insert_case_arrival_finish_rate
+   pm4py.analysis.solve_marking_equation
+   pm4py.analysis.check_soundness
+   pm4py.analysis.insert_artificial_start_end
+   pm4py.analysis.check_is_workflow_net
+   pm4py.analysis.maximal_decomposition
+   pm4py.analysis.generate_marking
+   pm4py.analysis.compute_emd
+   pm4py.analysis.reduce_petri_net_invisibles
+   pm4py.analysis.reduce_petri_net_implicit_places
+   pm4py.analysis.get_enabled_transitions
+   pm4py.utils
+   pm4py.utils.rebase
+   pm4py.utils.parse_process_tree
+   pm4py.utils.parse_powl_model_string
+   pm4py.utils.format_dataframe
+   pm4py.utils.serialize
+   pm4py.utils.deserialize
+   pm4py.utils.parse_event_log_string
+   pm4py.utils.project_on_event_attribute
+   pm4py.utils.sample_cases
+   pm4py.utils.sample_events