Skip to content

Enhance folder structure #137

Closed
Closed
@xinyi-joffre

Description

@xinyi-joffre

It would be great to improve the existing docs/code.md file by actually showing the full folder structure along with the explanations. Also, the pipelines heading should maybe more specifically call out "AzDO Pipelines"

Along with that change, below are some other considerations for the folders structure of this repo.

Proposed changes:

  1. Have an example of how to manage model configuration and what are the best practices for managing it in production. For instance, for some teams, it can help to check in the model_config.json to the repo if there are many parameters. This means it can be peer reviewed.
  2. Have a place to hold notebooks or other prototype files (consider "playground", "experimentation", or "notebooks" folder)
  3. If possible, it would be good to reduce the number of sys.path imports, since regular imports have more intellisense and get by the linter easier
  4. Test location is debatable, but having tests close to the individual scripts may be easier to maintain for larger repos
  5. Consider renaming "code" to the project name, since "code" is a python built-in module and causes interesting behavior with vscode test discovery
  6. Consider how to handle multiple models that may share common code. We could consider calling out how to do it in the "Bring your own model" docs.
  7. It make sense to add a .amlignore file in the repo to ignore /tests and other non-required files

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions