Skip to content

Allow grouping and providing extra metadata for datasets, methods and metrics #927

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

Open
rcannood opened this issue Jun 6, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@rcannood
Copy link
Member

rcannood commented Jun 6, 2025

Example:

__merge__: /src/api/comp_metric.yaml
name: clustering_overlap
info:
  metric_type: graph
  metrics:
    - name: ari
      label: ARI
      summary: ...
      description: ...
      references:
        doi:
          - 10.1038/s41592-021-01336-8
          - 10.1007/bf01908075
      links:
        homepage: https://scib.readthedocs.io/en/latest/
        documentation: https://scib.readthedocs.io/en/latest/api/scib.metrics.silhouette_batch.html
        repository: https://github.com/theislab/scib
      min: 0
      max: 1
      maximize: true
      group: mygroup
      metadata: # always a <string, atomic value> pair
        icon: https://path/to/foo
@rcannood rcannood added the enhancement New feature or request label Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant