diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 0000000..f2132ba --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,115 @@ +# Ultralytics YOLO ๐Ÿš€, AGPL-3.0 license +# Continuous Integration (CI) GitHub Actions tests broken link checker using https://github.com/lycheeverse/lychee +# Ignores the following status codes to reduce false positives: +# - 401(Vimeo, 'unauthorized') +# - 403(OpenVINO, 'forbidden') +# - 429(Instagram, 'too many requests') +# - 500(Zenodo, 'cached') +# - 502(Zenodo, 'bad gateway') +# - 999(LinkedIn, 'unknown status code') + +name: Check Broken Website links + +on: + workflow_dispatch: + #schedule: + # - cron: "0 0 * * *" # runs at 00:00 UTC every day + +jobs: + Links: + runs-on: ubuntu-latest + strategy: + fail-fast: false # This ensures that if one job fails, the others will still run + matrix: + website: [handbook.ultralytics.com] + steps: + - name: Download and install lychee + run: | + LYCHEE_URL=$(curl -s https://api.github.com/repos/lycheeverse/lychee/releases/latest | grep "browser_download_url" | grep "x86_64-unknown-linux-gnu.tar.gz" | cut -d '"' -f 4) + curl -L $LYCHEE_URL -o lychee.tar.gz + tar xzf lychee.tar.gz + sudo mv lychee /usr/local/bin + + - name: Download Website + run: | + # Download sitemap.xml + wget -O sitemap.xml https://${{ matrix.website }}/sitemap.xml + + # Parse URLs using a combination of tr, sed, and grep + tr '\n' ' ' < sitemap.xml | \ + sed 's//\n/g' | \ + grep -oP '(?<=).*?(?=)' | \ + sed 's/^[[:space:]]*//;s/[[:space:]]*$//' > urls.txt + + # Count total URLs to be downloaded + total_urls=$(wc -l < urls.txt) + echo "Total URLs to be downloaded: $total_urls" + + # Download all URLs + wget \ + --adjust-extension \ + --reject "*.jpg*,*.jpeg*,*.png*,*.gif*,*.webp*,*.svg*,*.txt" \ + --input-file=urls.txt \ + --no-clobber \ + --no-parent \ + --wait=0.001 \ + --random-wait \ + --tries=3 \ + --no-verbose \ + --force-directories + + - name: Run Broken Link Checks on Website + id: lychee + uses: nick-fields/retry@v3 + with: + timeout_minutes: 60 + retry_wait_seconds: 300 + max_attempts: 3 + command: | + # Count successfully downloaded files + downloaded_files=$(find ${{ matrix.website }} -type f | wc -l) + echo "Scanning $downloaded_files downloaded pages for broken links..." + + # Create summary.txt with the total page count + echo "*Results for $downloaded_files pages in https://${{ matrix.website }}*" > summary.txt + echo "" >> summary.txt + + rm -rf .lycheecache + lychee \ + --scheme 'https' \ + --timeout 60 \ + --insecure \ + --accept 401,403,429,500,502,999 \ + --exclude-all-private \ + --exclude 'https?://(www\.)?(linkedin\.com|twitter\.com|instagram\.com|kaggle\.com|tiktok\.com|fonts\.gstatic\.com|fonts\.googleapis\.com|url\.com|tesla\.com|wellfound\.com|.*\.cloudfunctions\.net|0\.0\.0\.0:5543/predict/from_files)' \ + --exclude-path '**/ci.yaml' \ + --github-token ${{ secrets.GITHUB_TOKEN }} \ + --header "User-Agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.183 Safari/537.36" \ + './${{ matrix.website }}/**/*.html' | tee -a summary.txt + + # Add the summary to GitHub step summary + cat summary.txt >> $GITHUB_STEP_SUMMARY + + # Prepare the summary for Slack (escape newlines, remove [], remove .html, and escape special characters) + ESCAPED_SUMMARY=$(awk '{printf "%s\\n", $0}' summary.txt | sed 's/\[//g; s/\]//g; s/\.html//g; s/"/\\"/g') + echo "SUMMARY<> $GITHUB_ENV + echo "$ESCAPED_SUMMARY" >> $GITHUB_ENV + echo "EOF" >> $GITHUB_ENV + + # Check if lychee found any broken links + if grep -q "0 Errors" summary.txt; then + echo "No broken links found." + exit 0 + else + echo "Broken links found." + exit 1 + fi + + - name: Check for failure and notify + if: always() && steps.lychee.outcome == 'failure' && github.event_name == 'schedule' + uses: slackapi/slack-github-action@v1.27.0 + with: + payload: | + {"text": "GitHub Actions: Errors found in ${{ github.workflow }} for ${{ matrix.website }} โŒ\n\n\n*Repository:* https://github.com/${{ github.repository }}\n*Action:* https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n*Author:* ${{ github.actor }}\n*Event:* ${{ github.event_name }}\n\n\n${{ env.SUMMARY }}\n"} + env: + SLACK_WEBHOOK_URL: ${{ matrix.website == 'www.ultralytics.com' && secrets.SLACK_WEBHOOK_URL_WEBSITE || secrets.SLACK_WEBHOOK_URL_YOLO }} diff --git a/README.md b/README.md index 90df1fa..ba259f4 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,132 @@ +
Ultralytics logo -# ๐Ÿ›  Ultralytics Python Project Template +# ๐Ÿ“š Ultralytics Handbook -This repository serves as the template for Python projects at [Ultralytics](https://www.ultralytics.com/). It encapsulates best practices, standard configurations, and essential project structures, streamlining the initiation process for new Python projects. By leveraging this template, developers at Ultralytics can ensure consistency and adherence to quality standards across all Python-based software developments. +The Ultralytics Handbook is your guide to our mission, vision, values, and practices, providing key insights and resources to align with Ultralytics' core principles. This repository is built and maintained directly from the **Handbook repo**, reflecting the latest updates. -[![Ultralytics Actions](https://github.com/ultralytics/template/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/template/actions/workflows/format.yml) Discord Ultralytics Forums Ultralytics Reddit +[![pages-build-deployment](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment) +[![Check Broken links](https://github.com/ultralytics/handbook/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/links.yml) +[![Ultralytics Actions](https://github.com/ultralytics/handbook/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/format.yml) -## ๐Ÿ—‚ Repository Structure +Discord Ultralytics Forums Ultralytics Reddit -The repository is meticulously organized to offer intuitive navigation and a clear understanding of the project components: +## ๐Ÿ› ๏ธ Installation -- `src/` or `your_package_name/`: Contains the source code of the Python package, organized in modules and packages. -- `tests/`: Dedicated to unit tests and integration tests, facilitating continuous testing practices. -- `docs/`: (Optional) Houses project documentation, typically managed with tools like Sphinx. -- `requirements.txt` or `Pipfile`: Lists all necessary Python package dependencies. -- `.gitignore`: Configured to exclude unnecessary files from Git tracking. -- `LICENSE`: Specifies the open-source license under which the project is released. -- `.github/workflows/`: Contains GitHub Actions workflows for CI/CD processes. -- `.pre-commit-config.yaml`: (Optional) Pre-commit hooks configuration for maintaining code quality. -- `Dockerfile`: (Optional) For containerizing the project environment. -- `environment.yml`: (Optional, for Conda users) Manages Conda environment dependencies. -- `setup.py`: (Optional, if using PyPI) Details for packaging and distributing the project. -- Linting and formatting configuration files (like `.flake8`, `.pylintrc`, `pyproject.toml`). +[![PyPI - Version](https://img.shields.io/pypi/v/ultralytics?logo=pypi&logoColor=white)](https://pypi.org/project/ultralytics/) +[![Downloads](https://static.pepy.tech/badge/ultralytics)](https://pepy.tech/project/ultralytics) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ultralytics?logo=python&logoColor=gold)](https://pypi.org/project/ultralytics/) +To install the ultralytics package in developer mode, ensure you have Git and Python 3 installed on your system. Then, follow these steps: + +1. Clone the ultralytics repository to your local machine using Git: + + ```bash + git clone https://github.com/ultralytics/ultralytics.git + ``` + +2. Navigate to the cloned repository's root directory: + + ```bash + cd ultralytics + ``` + +3. Install the package in developer mode using pip (or pip3 for Python 3): + + ```bash + pip install -e '.[dev]' + ``` + +- This command installs the ultralytics package along with all development dependencies, allowing you to modify the package code and have the changes immediately reflected in your Python environment. + +## ๐Ÿš€ Building and Serving Locally + +The `mkdocs serve` command builds and serves a local version of your MkDocs documentation, ideal for development and testing: + +```bash +mkdocs serve ``` -your-project/ -โ”‚ -โ”œโ”€โ”€ your_package_name/ -โ”‚ โ”œโ”€โ”€ __init__.py -โ”‚ โ”œโ”€โ”€ module1.py -โ”‚ โ”œโ”€โ”€ module2.py -โ”‚ โ””โ”€โ”€ ... -โ”‚ -โ”œโ”€โ”€ tests/ -โ”‚ โ”œโ”€โ”€ __init__.py -โ”‚ โ”œโ”€โ”€ test_module1.py -โ”‚ โ””โ”€โ”€ ... -โ”‚ -โ”œโ”€โ”€ docs/ -โ”‚ โ””โ”€โ”€ ... -โ”‚ -โ”œโ”€โ”€ pyproject.toml -โ””โ”€โ”€ README.md -``` -### Source Code in `src/` or `your_package_name/` Directory ๐Ÿ“‚ +- #### Command Breakdown: + + - `mkdocs` is the main MkDocs command-line interface. + - `serve` is the subcommand to build and locally serve your documentation. + +- ๐Ÿง Note: + + - Grasp changes to the docs in real-time as `mkdocs serve` supports live reloading. + - To stop the local server, press `CTRL+C`. + +## ๐ŸŒ Building and Serving Multi-Language -The `src/` or `your_package_name/` directory is the heart of your project, containing the Python code that constitutes your package. This structure encourages clean imports and testing practices. +Supporting multi-language documentation? Follow these steps: -### Testing with the `tests/` Directory ๐Ÿงช +1. Stage all new language \*.md files with Git: -The `tests/` directory is crucial for maintaining the reliability and robustness of your code. It should include comprehensive tests that cover various aspects of your package. + ```bash + git add docs/**/*.md -f + ``` -### Documentation in `docs/` Directory ๐Ÿ“š +2. Build all languages to the `/site` folder, ensuring relevant root-level files are present: -For projects requiring extensive documentation, the `docs/` directory serves as the go-to place. It's typically set up with Sphinx for generating high-quality documentation. + ```bash + # Clear existing /site directory + rm -rf site -## โž• Starting a New Project + # Loop through each language config file and build + mkdocs build -f docs/mkdocs.yml + for file in docs/mkdocs_*.yml; do + echo "Building MkDocs site with $file" + mkdocs build -f "$file" + done + ``` -To kickstart a new Python project with this template: +3. To preview your site, initiate a simple HTTP server: -1. **Create Your New Repository**: Use this template to generate a new repository for your project. -2. **Customize the Template**: Tailor the template files like `requirements.txt`, `.pre-commit-config.yaml`, and GitHub workflow YAMLs to suit your project's needs. -3. **Develop Your Package**: Begin adding your code into the `src/` or `your_package_name/` directory and corresponding tests in the `tests/` directory. -4. **Document Your Project**: Update the README and, if necessary, add documentation to the `docs/` directory. -5. **Continuous Integration**: Leverage the pre-configured GitHub Actions for automated testing and other CI/CD processes. + ```bash + cd site + python -m http.server + # Open in your preferred browser + ``` -## ๐Ÿ”ง Utilizing the Template +- ๐Ÿ–ฅ๏ธ Access the live site at `http://localhost:8000`. -For Ultralytics team members and contributors: +## ๐Ÿ“ค Deploying Your Documentation Site -- Clone the template repository to get started on a new Python project. -- Update the `README.md` to reflect your project's specifics. -- Remove or modify any optional components (like `Dockerfile`, `environment.yml`) based on the project's requirements. +Choose a hosting provider and deployment method for your MkDocs documentation: -With this template, Ultralytics aims to foster a culture of excellence and uniformity in Python software development, ensuring that each project is built on a solid foundation of industry standards and organizational best practices. +- Configure `mkdocs.yml` with deployment settings. +- Use `mkdocs deploy` to build and deploy your site. + +* ### GitHub Pages Deployment Example: + ```bash + mkdocs gh-deploy + ``` + +- Update the "Custom domain" in your repository's settings for a personalized URL. + +![196814117-fc16e711-d2be-4722-9536-b7c6d78fd167](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png) + +- For detailed deployment guidance, consult the [MkDocs documentation](https://www.mkdocs.org/user-guide/deploying-your-docs/). ## ๐Ÿ’ก Contribute -Ultralytics thrives on community collaboration; we immensely value your involvement! We urge you to peruse our [Contributing Guide](https://docs.ultralytics.com/help/contributing) for detailed insights on how you can participate. Don't forget to share your feedback with us by contributing to our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you ๐Ÿ™ goes out to everyone who has already contributed! +We value community contributions and feedback to continuously improve the Ultralytics Handbook. For guidelines on contributing, please refer to the [Contributing Guide](https://docs.ultralytics.com/help/contributing). + + - -Ultralytics open-source contributors +![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png) -## ๐Ÿ“„ License +## ๐Ÿ“œ License -Ultralytics presents two distinct licensing paths to accommodate a variety of scenarios: +The Ultralytics Handbook is licensed under the following options: -- **AGPL-3.0 License**: This official [OSI-approved](https://opensource.org/license) open-source license is perfectly aligned with the goals of students, enthusiasts, and researchers who believe in the virtues of open collaboration and shared wisdom. Details are available in the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) document. -- **Enterprise License**: Tailored for commercial deployment, this license authorizes the unfettered integration of Ultralytics software and AI models within commercial goods and services, without the copyleft stipulations of AGPL-3.0. Should your use case demand an enterprise solution, direct your inquiries to [Ultralytics Licensing](https://www.ultralytics.com/license). +- **AGPL-3.0 License**: Suitable for academic and collaborative work. See the [LICENSE](https://github.com/ultralytics/handbook/blob/main/LICENSE) file for details. +- **Enterprise License**: Ideal for commercial use, integrating Ultralytics' solutions into proprietary products. Visit [Ultralytics Licensing](https://www.ultralytics.com/license) for more details. -## ๐Ÿ“ฎ Contact +## โœ‰๏ธ Contact -For bugs or feature suggestions pertaining to Ultralytics, please lodge an issue via [GitHub Issues](https://github.com/ultralytics/template/issues). You're also invited to participate in our [Discord](https://discord.com/invite/ultralytics) community to engage in discussions and seek advice! +For bug reports or feature requests, please use [GitHub Issues](https://github.com/ultralytics/handbook/issues). You can also engage with the Ultralytics team and community on [Discord](https://discord.com/invite/ultralytics).
diff --git a/docs/company-guidelines/index.md b/docs/company-guidelines/index.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/company-guidelines/index.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/contributions/community-engagement.md b/docs/contributions/community-engagement.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/contributions/community-engagement.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/contributions/how-to-contribute.md b/docs/contributions/how-to-contribute.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/contributions/how-to-contribute.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/faq/index.md b/docs/faq/index.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/faq/index.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/goals/company-goals.md b/docs/goals/company-goals.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/goals/company-goals.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/goals/okrs.md b/docs/goals/okrs.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/goals/okrs.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..3ab18d1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ +# Welcome to the Ultralytics Handbook + +Welcome to the Ultralytics Handbook, your comprehensive guide to our companyโ€™s mission, vision, values, and operational practices. This handbook is designed to provide key insights and resources for our team members, collaborators, and community to align with Ultralytics' core principles. + +Whether youโ€™re here to learn about our mission, contribute to our open-source projects, or understand our internal workflows, youโ€™ll find everything you need to get started right here. + +## ๐Ÿ’ก How to Use This Handbook + +This handbook is a living document and will be regularly updated as Ultralytics continues to grow. It serves as both a practical resource and a philosophical guide to our company culture and operations. Whether you're part of the team or an external contributor, this is the place to find everything you need. + +Happy reading and contributing! diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..4419b23 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,39 @@ +# Introduction + +Welcome to the Ultralytics Handbook! This handbook serves as a comprehensive guide to everything Ultralytics: our mission, vision, values, company guidelines, and workflows. Whether youโ€™re a team member, contributor, or community member, this document is designed to align everyone with the principles and practices that drive our work. + +## About Ultralytics + +Ultralytics is a world leader in artificial intelligence, committed to advancing the boundaries of AI and creating cutting-edge machine learning tools. Our work is focused on providing open-source solutions that empower individuals and organizations globally. By combining technical excellence with an unwavering commitment to our values, we aim to democratize AI and make it accessible to everyone, regardless of background or resources. + +## Purpose of the Handbook + +This handbook was created to: + +- Provide clarity and consistency about how we work, collaborate, and contribute to our shared goals. +- Outline our core principles, mission, and vision, guiding every decision and action within the company. +- Offer practical guidance for team members, contributors, and collaborators on how to engage effectively with Ultralytics. + +The handbook is designed to be a **living document** that will evolve with the company. Itโ€™s not just a set of rules but a reflection of our culture and how we collectively strive to make an impact through AI. + +## Who is this Handbook For? + +This handbook is for: + +- **Ultralytics team members**: To understand internal processes, workflows, and company culture. +- **Contributors and collaborators**: To guide their contributions and participation in open-source projects. +- **The wider Ultralytics community**: To align with our mission and values while interacting with Ultralytics projects and platforms. + +## How to Use the Handbook + +The Ultralytics Handbook is divided into clear sections that cover everything from company philosophy to specific workflows. The **Table of Contents** on the home page provides a simple way to navigate through the different topics. Whether you're new to Ultralytics or looking to deepen your understanding of our practices, this handbook is here to help. + +### Key Sections + +- **Mission, Vision, and Values**: Understand the foundational principles that guide everything we do. +- **Workflows and Processes**: Learn about the operational side of Ultralytics, including development and collaboration processes. +- **Contributions and Community**: Discover how to contribute to our open-source projects and engage with the broader Ultralytics community. + +--- + +Thank you for being part of Ultralytics! Whether you're a new team member, an open-source contributor, or simply someone interested in AI, we hope this handbook provides you with the information and inspiration to contribute meaningfully to our shared goals. diff --git a/docs/legal/licenses.md b/docs/legal/licenses.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/legal/licenses.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/legal/privacy-policy.md b/docs/legal/privacy-policy.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/legal/privacy-policy.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/mission-vision-values/index.md b/docs/mission-vision-values/index.md new file mode 100644 index 0000000..bc5425a --- /dev/null +++ b/docs/mission-vision-values/index.md @@ -0,0 +1,29 @@ +# Ultralytics Mission, Vision, & Values + +## Mission + +To move the world forward by first moving ourselves, continuously pushing the boundaries of AI through relentless execution, creating the world's best open-source solutions that benefit everyone equally and empower individuals to improve their lives and the lives of those around them. + +## Vision + +To create a future where every person, regardless of means or background, has equal access to transformative AI, enabling them to seize opportunities and shape their own path. Aware that our time is finite, we strive to make a lasting impact that benefits future generations. + +## Values + +1. **Relentless Progress**: We are constantly evolving and improving. Just as life is ever-changing, we never rest at the middleโ€”we aim for continuous progress in everything we do. + +2. **Dedication to Details**: True excellence is achieved through perseverance. We believe that even the smallest details matter, and through steady refinement, we create great things. + +3. **Actions, Not Words**: We are defined by what we do, not what we say we will do. We emphasize action, knowing that results speak louder than intentions. + +4. **Results Above All**: Success comes from tangible outcomes, not intentions or aspirations. We focus on delivering results that truly matter, action by action. + +5. **Act with Urgency**: Our time is finite, and we do not know how finite. Opportunities are fleeting, and we move swiftly to capture them in a competitive world. + +6. **Open Access to All**: The future belongs to everyone, and so should AI. We are committed to providing world-class AI solutions openly, ensuring that everyone can benefit and innovate. + +7. **Equality of Opportunity**: We are committed to leveling the playing field, ensuring everyone, regardless of background or circumstances, can access and benefit from world-class AI to shape their future. + +8. **Embrace Failure**: In our pursuit of relentless progress, we recognize that failure is essential for growth. There is no advancement without setbacksโ€”what stands in the way becomes the way, and each challenge is a stepping stone toward success. + +9. **Resilience**: Great achievements demand perseverance. We rise after every fall, staying focused and determined, knowing that lasting success is built through resilience in the face of obstacles. diff --git a/docs/mkdocs_github_authors.yaml b/docs/mkdocs_github_authors.yaml new file mode 100644 index 0000000..590436c --- /dev/null +++ b/docs/mkdocs_github_authors.yaml @@ -0,0 +1,9 @@ +not.committed.yet: + avatar: https://avatars.githubusercontent.com/u/135830346?v=4 + username: UltralyticsAssistant +web@ultralytics.com: + avatar: https://avatars.githubusercontent.com/u/135830346?v=4 + username: UltralyticsAssistant +glenn.jocher@ultralytics.com: + avatar: https://avatars.githubusercontent.com/u/26833433?v=4 + username: glenn-jocher diff --git a/docs/team-roles/index.md b/docs/team-roles/index.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/team-roles/index.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/team-roles/specific-roles.md b/docs/team-roles/specific-roles.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/team-roles/specific-roles.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/tools/developer-tools.md b/docs/tools/developer-tools.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/tools/developer-tools.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/tools/learning-resources.md b/docs/tools/learning-resources.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/tools/learning-resources.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/workflows/ci-testing.md b/docs/workflows/ci-testing.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/workflows/ci-testing.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/workflows/development.md b/docs/workflows/development.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/workflows/development.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/workflows/documentation.md b/docs/workflows/documentation.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/workflows/documentation.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/docs/workflows/product-development.md b/docs/workflows/product-development.md new file mode 100644 index 0000000..dcbf61b --- /dev/null +++ b/docs/workflows/product-development.md @@ -0,0 +1,34 @@ +--- +description: Explore the Ultralytics Handbookโ€”a comprehensive guide to our mission, vision, values, and internal workflows. Stay tuned for exciting updates as we continue to build this resource. +keywords: Ultralytics Handbook, coming soon, under construction, internal guide, mission, vision, values, workflows, open-source, AI guidelines +--- + +# Handbook Under Construction ๐Ÿ—๏ธ๐Ÿ“– + +Welcome to the [Ultralytics](https://www.ultralytics.com/) [Handbook](https://handbook.ultralytics.com/) "Under Construction" page! We are diligently crafting a comprehensive guide that will serve as your go-to resource for understanding our mission, vision, values, workflows, and company practices. This page is a preview of the detailed documentation and guidelines soon to be available. + +## What to Expect from the Handbook ๐Ÿ“˜ + +- **Mission and Values:** Learn what drives Ultralytics forward and how we aim to make a lasting impact. +- **Operational Workflows:** Discover how we work internally, including development processes, team collaboration, and continuous improvement. +- **Contribution Guidelines:** Get involved! Detailed instructions on how to contribute to our projects and be part of the Ultralytics community. + +## Stay Informed ๐Ÿšง + +This placeholder page is just the start. Soon, youโ€™ll have access to: + +- **Internal Workflows:** Best practices for development, testing, and open-source contributions. +- **Team Roles:** Detailed roles and responsibilities for team members and contributors. +- **Collaboration Guidelines:** Clear guidance for collaborating on projects and contributing effectively. + +## Be a Part of the Handbook ๐Ÿ—ฃ๏ธ + +We value your input as we develop this resource. If you have suggestions or feedback, share your thoughts [here](https://www.ultralytics.com/survey). + +## Thank You to Our Community ๐ŸŒ + +Your [contributions](https://docs.ultralytics.com/help/contributing/) and feedback drive us to keep improving and refining the way we work at Ultralytics. Stay tuned as we roll out the complete handbook to help you engage, contribute, and align with our mission and values. + +--- + +Excited for the Ultralytics Handbook? Bookmark this page and be the first to explore our internal processes and principles as we continue to build and share our journey with you! ๐Ÿ“–โœจ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..50dfb3f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,201 @@ +# Ultralytics YOLO ๐Ÿš€, AGPL-3.0 license + +# Configuration file for building the Ultralytics YOLO documentation site using MkDocs. +# Provides settings to control site metadata, customize the appearance using the +# Material theme, define the navigation structure, and enable various plugins. + +# Site metadata +site_name: Ultralytics Handbook +site_description: A guide to Ultralytics' mission, vision, values, and practices, providing key insights and resources for aligning with our goals. +site_url: https://handbook.ultralytics.com +site_author: Ultralytics +repo_url: https://github.com/ultralytics/handbook +edit_uri: https://github.com/ultralytics/handbook/tree/main/docs/ +repo_name: ultralytics/handbook +remote_name: https://github.com/ultralytics/handbook +docs_dir: "docs/" # where to find the markdown files +site_dir: "site/" # where to publish to + +# Theme customization +theme: + name: material + language: en + # custom_dir: docs/overrides/ + logo: https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Reverse.svg + favicon: assets/favicon.ico + icon: + repo: fontawesome/brands/github + # font: # disabled for faster page load times + # text: Helvetica + # code: Roboto Mono + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: black + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to system preference + - media: "(prefers-color-scheme: light)" + scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + features: + - content.action.edit + - content.code.annotate + - content.code.copy + - content.tooltips + - search.highlight + - search.share + - search.suggest + - toc.follow + - navigation.top + - navigation.tabs + - navigation.tabs.sticky + - navigation.prune + - navigation.footer + - navigation.tracking + - navigation.instant + - navigation.instant.progress + - navigation.indexes + - navigation.sections # navigation.expand or navigation.sections + - content.tabs.link # all code tabs change simultaneously + +# Customization +copyright: ยฉ 2024 Ultralytics Inc. All rights reserved. +extra: # version: + # provider: mike # version drop-down menu + robots: robots.txt + analytics: + provider: google + property: G-2M5EHKC0BH + social: + - icon: fontawesome/brands/github + link: https://github.com/ultralytics + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/ultralytics/ + - icon: fontawesome/brands/x-twitter + link: https://twitter.com/ultralytics + - icon: fontawesome/brands/youtube + link: https://youtube.com/ultralytics?sub_confirmation=1 + - icon: fontawesome/brands/docker + link: https://hub.docker.com/r/ultralytics/ultralytics/ + - icon: fontawesome/brands/python + link: https://pypi.org/project/ultralytics/ + - icon: fontawesome/brands/discord + link: https://ultralytics.com/discord + - icon: fontawesome/brands/reddit + link: https://reddit.com/r/ultralytics + +extra_css: + - https://raw.githubusercontent.com/ultralytics/ultralytics/refs/heads/main/docs/overrides/stylesheets/style.css +extra_javascript: + - https://raw.githubusercontent.com/ultralytics/ultralytics/refs/heads/main/docs/overrides/javascript/extra.js + +markdown_extensions: + - admonition + - md_in_html + - tables + - attr_list + - def_list + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - pymdownx.details + - pymdownx.superfences + - pymdownx.inlinehilite + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.snippets: + base_path: ./ + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.tabbed: + alternate_style: true + +# Validation settings https://www.mkdocs.org/user-guide/configuration/#validation +validation: + nav: + omitted_files: info + not_found: warn + absolute_links: info + links: + absolute_links: relative_to_docs + anchors: warn + unrecognized_links: warn + +# Primary navigation --------------------------------------------------------------------------------------------------- +nav: + - Home: + - Home: index.md + - Intro: introduction.md + - Mission & Values: mission-vision-values/index.md + - Guidelines: company-guidelines/index.md + - Team Roles: + - Overview: team-roles/index.md + - Specific Roles: team-roles/specific-roles.md + - Workflows: + - Development: workflows/development.md + - Product Dev: workflows/product-development.md + - CI/Testing: workflows/ci-testing.md + - Documentation: workflows/documentation.md + - Community: + - How to Contribute: contributions/how-to-contribute.md + - Engagement: contributions/community-engagement.md + - Resources: + - Dev Tools: tools/developer-tools.md + - Learning: tools/learning-resources.md + - Goals & OKRs: + - Company Goals: goals/company-goals.md + - OKRs: goals/okrs.md + - FAQ: faq/index.md + - Legal: + - Licenses: legal/licenses.md + - Privacy Policy: legal/privacy-policy.md + - Intro: introduction.md + - Mission & Values: mission-vision-values/index.md + - Guidelines: company-guidelines/index.md + - Team Roles: + - Overview: team-roles/index.md + - Specific Roles: team-roles/specific-roles.md + - Workflows: + - Development: workflows/development.md + - Product Dev: workflows/product-development.md + - CI/Testing: workflows/ci-testing.md + - Documentation: workflows/documentation.md + - Community: + - How to Contribute: contributions/how-to-contribute.md + - Engagement: contributions/community-engagement.md + - Resources: + - Dev Tools: tools/developer-tools.md + - Learning: tools/learning-resources.md + - Goals & OKRs: + - Company Goals: goals/company-goals.md + - OKRs: goals/okrs.md + - FAQ: faq/index.md + - Legal: + - Licenses: legal/licenses.md + - Privacy Policy: legal/privacy-policy.md + +# Plugins including 301 redirects navigation --------------------------------------------------------------------------- +plugins: + - search: + lang: en + - ultralytics: + add_desc: False + add_image: True + add_authors: True + add_json_ld: True + add_share_buttons: True + add_css: False + default_image: https://raw.githubusercontent.com/ultralytics/assets/main/yolov8/banner-yolov8.png diff --git a/template/README.md b/template/README.md deleted file mode 100644 index f9bf8ec..0000000 --- a/template/README.md +++ /dev/null @@ -1,18 +0,0 @@ -
-Ultralytics logo - -# Source Code Directory (`src/` or `your_package_name/`) - -The root directory of this project serves as the container for the Python source code. - -## Structure - -- Our project is organized directly at the root level into modules and sub-packages. -- Each sub-package or module resides in its own dedicated folder or file right at the root. -- The `pyproject.toml` file, also at the root of our project, defines the packaging configurations. - -## Guidelines - -- Ensure that code is well-documented and adheres to Ultralytics coding standards. -- Introduce new modules or packages as necessary, maintaining a logical and clean structure directly at the root level. -- All code should be rigorously tested and verified for functionality and performance, ensuring high-quality standards are upheld. diff --git a/template/__init__.py b/template/__init__.py deleted file mode 100644 index 1d33b27..0000000 --- a/template/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -# Ultralytics YOLO ๐Ÿš€, AGPL-3.0 License https://ultralytics.com/license - -__version__ = "0.0.0" diff --git a/template/module1.py b/template/module1.py deleted file mode 100644 index fc3c13f..0000000 --- a/template/module1.py +++ /dev/null @@ -1,28 +0,0 @@ -# Ultralytics YOLO ๐Ÿš€, AGPL-3.0 License https://ultralytics.com/license - - -def add_numbers(a, b): - """ - Adds two numbers and returns the sum. - - Args: - a (float | int): The first number in the addition. - b (float | int): The second number in the addition. - - Returns: - (float | int): The sum of `a` and `b`. - - Notes: - This function supports both integer and floating-point numbers. The returned value will match the type of the input - values unless they're mixed, in which case a float is returned. - - Examples: - ```python - result = add_numbers(3, 5) - assert result == 8 - - result = add_numbers(3.5, 2) - assert result == 5.5 - ``` - """ - return a + b diff --git a/tests/README.md b/tests/README.md deleted file mode 100644 index 2d542c0..0000000 --- a/tests/README.md +++ /dev/null @@ -1,21 +0,0 @@ -
-Ultralytics logo - -# Tests Directory (`tests/`) - -This directory houses the tests for our project, primarily using pytest for testing. - -## Overview - -- Contains test scripts written in Python. -- Organized to mirror the structure of the `src/` directory for easy reference. -- Tests should be comprehensive and cover a wide range of cases. - -## Running Tests - -To execute the tests: - -1. **Install pytest:** Ensure pytest is installed in your environment. -2. **Run Tests:** Execute `pytest` in the root directory of the project. - -Make sure to regularly run tests to maintain the reliability and quality of the project. diff --git a/tests/test_module1.py b/tests/test_module1.py deleted file mode 100644 index 14302ef..0000000 --- a/tests/test_module1.py +++ /dev/null @@ -1,23 +0,0 @@ -# Ultralytics YOLO ๐Ÿš€, AGPL-3.0 License https://ultralytics.com/license - -from module1 import add_numbers - - -def test_add_numbers(): - """ - Test the add_numbers function from module1 by verifying the correctness of summation operation between pairs of - integers. - - Tests: - - Ensures that the sum of 2 and 3 equals 5. - - Validates that the sum of -1 and 1 equals 0. - - Returns: - (None): This function performs assertions to validate the behavior of add_numbers. It does not return a value. - - Raises: - AssertionError: If any of the assertions fail, this error is raised indicating a test case failure. - """ - assert add_numbers(2, 3) == 5 - assert add_numbers(-1, 1) == 0 - assert add_numbers(-1, -1) == -2