You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
One of the critical aspect of experiment tracking is creating different version of an artefact and track/evaluate their impact.. With the current design, I can see possibilities of bad UX:
1. Letting user to create new version of Prompt Template by changing every attribute
Whenever a user create a new version of an asset, they are allowed to change every asset attribute including Name and Description. To track an asset, the user is only left with an uuid - which is not pleasantly readable string
Proposal: User cannot change the name of the Name of an asset across different versions. Name and assed ID should be immutable. Description should be at the discretion of the user
2. User explicitly pass Asset ID while calling the create_or_update method
After creating an asset, it is up to user to properly pass the ID in subsequent version creation. A mismatch in it can lead to pretty bad experiment design.
Proposal: Let's handle it via a state variable and wrap the create_or_update method inside a class.
3. Asset definition in README.md is in conflict with the method name create_or_update
Minor issue - but I think should not use the name create_or_update because we explicitly mention in the doc that there is no concept of update in the assets, rather versions. If we go with proposal (2) - then we can have 2 explicit method: create_new_template and update_template_version
The text was updated successfully, but these errors were encountered:
One of the critical aspect of experiment tracking is creating different version of an artefact and track/evaluate their impact.. With the current design, I can see possibilities of bad UX:
1. Letting user to create new version of Prompt Template by changing every attribute
Whenever a user create a new version of an asset, they are allowed to change every asset attribute including Name and Description. To track an asset, the user is only left with an uuid - which is not pleasantly readable string
Proposal: User cannot change the name of the Name of an asset across different versions. Name and assed ID should be immutable. Description should be at the discretion of the user
2. User explicitly pass Asset ID while calling the
create_or_update
methodAfter creating an asset, it is up to user to properly pass the ID in subsequent version creation. A mismatch in it can lead to pretty bad experiment design.
Proposal: Let's handle it via a state variable and wrap the create_or_update method inside a class.
3. Asset definition in README.md is in conflict with the method name
create_or_update
Minor issue - but I think should not use the name
create_or_update
because we explicitly mention in the doc that there is no concept of update in the assets, rather versions. If we go with proposal (2) - then we can have 2 explicit method:create_new_template
andupdate_template_version
The text was updated successfully, but these errors were encountered: