Distinguish between petagogical, performance, application, etc examples

dwave-examples / template

A template for code examples on this account. See for details on contribution guidelines.

Apache License 2.0

25 stars 42 forks source link

Distinguish between petagogical, performance, application, etc examples #9

Open arcondello opened 3 years ago

arcondello commented 3 years ago

Perhaps a tag? And/or something in the README

mcfarljm commented 3 years ago

I think the README is the best place for this information (for example, the disclaimer in https://github.com/dwave-examples/qboost). There is room to convey more of the nuances. For example, if it is pedagogical, what specific things is it intended to illustrate (how to formulate a one-hot constraint? how to create an embedding? how to construct a penalty function?) To the extent possible, it would also be good to comment on performance, scalability, and "fit" for the system.