MLOps.NET icon indicating copy to clipboard operation
MLOps.NET copied to clipboard

LocalFileModelRepository - Add support for "safe names" for predictable file paths

Open mbrdev opened this issue 5 years ago • 1 comments

Is your feature request related to a problem? Please describe. Currently we are using things like Experiment Name and Deployment Name as part of file paths in the LocalFileModelRepository, if either of these names contain invalid characters for a file system path then we will be unable to save the files.

Describe the solution you'd like

  • Experiments would have a "safe name" that can be used in URLs and file paths, it would only support alphanumeric, hyphens, underscores and dot characters.
  • Deployments would have a "safe name" that can be used in URLs and file paths, it would only support alphanumeric, hyphens, underscores and dot characters.
  • All folder paths and/or URLs would use these safe names.

Describe alternatives you've considered

  • We discussed cleaning the names to remove any invalid character from the path, this however would result in unpredictable file paths
  • We discussed using just the IDs to form the paths but then this would make all paths unreadable
  • We discussed restricting the characters that can be used for naming but this may be undesired to change UI behaviour and display based on file system requirements

mbrdev avatar Aug 08 '20 14:08 mbrdev

@mbrdev would it make sense to create a service that generates safe names and we can use that where we need to have a safe name of a deployment target, expeiment and so forth?

aslotte avatar Oct 03 '20 13:10 aslotte