Successfully reported this slideshow.

SOMEF: a metadata extraction framework from software documentation

0

Share

1 of 7
1 of 7

SOMEF: a metadata extraction framework from software documentation

0

Share

Download to read offline

Presentation done at the council of software registries on March, 2021. SOMEF is a python package for automatically extracting over 25 metadata categories from a readme file. The output is then exported in JSON or in JSON-LD using the codemeta representation

Presentation done at the council of software registries on March, 2021. SOMEF is a python package for automatically extracting over 25 metadata categories from a readme file. The output is then exported in JSON or in JSON-LD using the codemeta representation

More Related Content

Related Books

Free with a 14 day trial from Scribd

See all

SOMEF: a metadata extraction framework from software documentation

  1. 1. SOMEF: A Metadata Extraction Framework from Software Documentation Daniel Garijo @dgarijov Ontology Engineering Group, Universidad Politécnica de Madrid
  2. 2. The Importance of Software Metadata - An increasing amount of software is available online - Metadata is critical for: - Findability - Reusability - Understanding > 100 M repositories > 28 M repositories
  3. 3. Current Pipeline for Software Metadata Curation Icons from https://icons8.com/ Develop software & documentation Create entry in registry Curation and Validation
  4. 4. SOMEF: Automating Software Metadata Extraction SOMEF ● Readme Analysis ○ Supervised classification ○ Regular expressions ○ Header analysis ● File exploration ○ Notebooks ○ Dockerfiles ○ Documentation ● GitHub API Repository Extraction Results (Metadata) https://github.com/KnowledgeCaptureAndDiscovery/somef/
  5. 5. Recognizing Metadata Categories ● Name (GA) ● Full title (RE) ● Description (SC, HA) ● Citation (SC, RE, HA) ● Installation instructions (SC, HA) ● Invocation (SC) ● Usage examples (HA) ● Documentation (HA, FE) ● Requirements (HA) ● Contributors (HA) ● FAQ (HA) ● Support (HA) ● License (GA, HA) ● Stars (GA) ● Contact (HA) ● Download URL (HA, GA) ● DOI (RE) ● DockerFile (FE) ● Notebooks (FE) ● Executable notebooks (Binder) (RE) ● Owner: (RE) ● Keywords (GA) ● Source code (GA) ● Releases (GA) ● Changelog (GA) ● Issue tracker (GA) ● Programming languages (GA) ● Acknowledgements (HA) Method used: ● Supervised Classification (SC) ● Header Analysis and Synset comparison (HA) ● File Exploration (FE) ● Regular Expressions (RE) ● GitHub API (GA)
  6. 6. Example Output
  7. 7. Beginning to capture software in context SOMEF helps automatically extract software metadata. Benefits: ● Let authors know what metadata is missing ● Help making software findable ● Capture context of software (setup, configuration, examples) But there is much more to explore: ● Better comparison ● Input/output preparation ● Using different software together Problems? Suggestions? New features? https://github.com/KnowledgeCaptureAndDiscovery/somef/issues

×