Best Practices¶

Project Naming Conventions

Establish naming conventions that align with your organization’s internal guidelines and promote clarity, consistency, and ease of identification for your projects in Tensoract Studio. Refer to following guidelines for project naming conventions.

  1. Be descriptive: Use a name that accurately describes the purpose or content of the project. Consider including project type such as NER, OCR or Object Detection as part of project name.

  2. Follow a consistent format: Establish a consistent format for project names within your organization to ensure uniformity and ease of identification.

  3. Use meaningful keywords: Include relevant keywords or terms that represent the domain, application, or focus of the project. Examples may include keywords describing a use case or application relevent to the project.

  4. Keep it concise: Aim for a concise and easily readable project name. Avoid excessively long or complicated names.

  5. Consider versioning if necessory: If you anticipate multiple versions or iterations of a project, you can include version numbers or labels to ifferentiate them.

    Here are some examples of project names:

    • NER-LeasingDocuments-v5

    • OCR-MedicalImaging-2023-01-01

    • VideoTranscription-NBA-beta