Skip to content

[Feature] XES-YAML - XES format extension #472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

ondrisvu
Copy link

@ondrisvu ondrisvu commented Mar 9, 2024

Description:
This PR introduces XES-YAML functionality, which serves as an extension for the supported XES log formats. The backward-compability with the existing pm4py’s implementation of the XES importer/exporter remains. This implementation was developed as part of a Bachelor's Thesis titled "More Efficient eXtensible Event Stream-XES-YAML-Format" at TUM.



Key Additions:

  1. XES-YAML Import/Export
    • read_yaml() function to parse XES-YAML files into pm4py’s native XES structure
    • write_yaml() function to serialize data into standards-compliant XES-YAML
  2. Illustrative Example
    • a sample event log in the XES-YAML log format, demonstrating:
      • representation of log, trace, event, and attribute structures
      • the sample consists of snippets from real-life .xes.yaml event logs
  3. Comprehensive Test Suite
    • conversion tests (correctness assurance), covering:
      • XES-XML to XES-YAML
      • XES-YAML to XES-XML
      • The aforementioned conversion tests ensure data integrity and format preservation across various conversions.
    • roundtrip tests
      • XES-YAML to XES-YAML
      • Roundtrip tests ensure log consistency between logs before/after export.

Backward Compability Focus:

  • seamless integration with current systems and data pipelines

Used libraries:

@ondrisvu ondrisvu changed the title Feature/xes yaml extension [Feature] XES-YAML - XES format extension Mar 9, 2024
@fit-alessandro-berti
Copy link
Contributor

Thanks. This is a contribution that from what I understood is going to be part of a larger set of PRs.

We would need to finalize a "contribution level agreement" before merging (as the contribution is non-trivial)

ondrisvu and others added 2 commits March 11, 2024 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants