Clarify if hardware type is equal to hardware requirements in the specification

[dgarijo]

Is your feature request related to a problem? Please describe.
We are reviewing the model card specification in order to adopt it. However, Hardware Type and hardware requirements have the same key hardware. We believe these entries are not the same, as I can require 2 GB of RAM and 2 H100 GPUs for running a model, but the the hardware_type is just GPU H100. Can you please clarify the intended use in the current documentation? (for hardware requirements there is no definition)

Describe the solution you'd like
Clarify if hardware_type and hardware requirements are mapped to the same key hardware

Thanks!

[pcuenca]

Interesting! My understanding is that "hardware type" times the "hours" gives an approximation for the total amount of compute, which is a very interesting figure to report. What do you think is important to cover in the "hardware requirements" field? cc @davanstrien for insight.

[dgarijo]

Looking at schema.org (which is often used as a reference to describe many resources in the web). They have:

• processorRequirements to indicate the processor architecture
• memoryRequirements to indicate minimum memory requirements
• storageRequirements to indicate the DISK space needed.

hardware is maybe a bit generic. By hardware_requirements I understand the minimum hw requirements, which indicate that a quantity is expected. By hardware_type I understand the type of that hardware.

If you clarify somewhere in the doc that you are only referring that the hardware recorded is the GPU type, and that "hardware type" times the "hours" is the approx time of compute (i.e., RAM, DISK are not addressed), that would really help a lot.

Thanks in advance!

[davanstrien]

I think @EziOzoani and @meg-huggingface are probably the best people to answer this.

[meg-huggingface]

Thank you so much for noticing this issue, @dgarijo !
Following your thoughts, we have now broken hardware into:

hardware_type
hardware_requirements

The updated template is here:
https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md

[dgarijo]

Thanks! Closing the issue then