DeepSpeed

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

If this is your project, please show your badge status on your project page! The badge status looks like this: Badge level for project 9530 is passing Here is how to embed it:

These are the Silver level criteria. You can also view the Passing or Gold level criteria.

        

 Basics 17/17

  • Identification

    DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.

  • Prerrequisitos


    The project MUST achieve a passing level badge. [achieve_passing]

  • Basic project website content


    The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements]
  • Supervisión del proyecto


    The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco]

    The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance]

    The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct]

    Code of Conduct posted in normal CODE_OF_CONDUCT.md file location and states that this project uses the Microsoft OSS Code of conduct: https://github.com/microsoft/DeepSpeed/blob/master/CODE_OF_CONDUCT.md



    The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities]

    Added and explained in governance doc here: https://github.com/microsoft/DeepSpeed/blob/master/GOVERNANCE.md



    The project MUST be able to continue with minimal interruption if any one person dies, is incapacitated, or is otherwise unable or unwilling to continue support of the project. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation of the loss of support from any one individual. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity]

    For the GitHub project, there are multiple people who could all add others to continue the project: https://github.com/orgs/deepspeedai/people



    The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor]

    As you can see from the Contributors graph here: https://github.com/microsoft/DeepSpeed/graphs/contributors there are plenty of contributors who could carry on in the event this was necessary.


  • Documentation


    The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap]

    Following vLLM repository approach of an issue per quarter tracking the roadmap: https://github.com/microsoft/DeepSpeed/issues/6946



    The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture]

    This is covered both on https://deepspeed/ai as well as on our ReadTheDocs page here: https://deepspeed.readthedocs.io/en/latest/



    The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security]

    The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start]

    The deepspeed.ai website has a list of starting integrations: https://www.deepspeed.ai/getting-started/, this is also covered in the README where it points to the DeepSpeed-MII and DeepSpeedExamples repo.



    The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current]

    The blogs and DeepSpeed website are both updated as the releases are released: https://github.com/microsoft/DeepSpeed/tree/master/blogs



    The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements]
  • Accessibility and internationalization


    The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices]

    The project website and GitHub both follow best practices for availability.



    The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization]

    This project doesn't produce any human readable text that is outside of the scope of the programming language


  • Other


    If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., Argon2id, Bcrypt, Scrypt, or PBKDF2). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security]

    Websites do not require any username/authentication from end users so there is nothing to store.


  • Versiones anteriores


    The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update]

    If breaking changes are made, they are documented in the release notes for which PRs have caused these changes, and the PRs themselves contain the needed steps to upgrade or links to those if they are dependent on other packages.


  • Bug-reporting process


    The project MUST use an issue tracker for tracking individual issues. [report_tracker]
  • Proceso de informe de vulnerabilidad


    The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit]

    No new vulnerability reports to GitHub, those submitted to Huntr and processed via Microsoft are all credited.



    The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process]

    Vulnerability reporting is covered under the SECURITY.md file here: https://github.com/microsoft/DeepSpeed/blob/master/SECURITY.md#security


  • Coding standards


    The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards]

    The specific coding styles that are used are identified in the config files here: https://github.com/microsoft/DeepSpeed/blob/master/.pylintrc



    The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced]

    This is automatically enforced in the "formatting" checks that use pre-commit and a number of tools, yapf, clang-format, etc. This is listed here: https://github.com/microsoft/DeepSpeed/blob/master/.pre-commit-config.yaml


  • Working build system


    Build systems for native binaries MUST honor the relevant compiler and linker (environment) variables passed in to them (e.g., CC, CFLAGS, CXX, CXXFLAGS, and LDFLAGS) and pass them to compiler and linker invocations. A build system MAY extend them with additional flags; it MUST NOT simply replace provided values with its own. If no native binaries are being generated, select "not applicable" (N/A). [build_standard_variables]

    Flags are only appended, for example, LD_FLAGS are only ever appended to here: https://github.com/search?q=repo%3Amicrosoft%2FDeepSpeed%20LDFLAGS&type=code



    The build and installation system SHOULD preserve debugging information if they are requested in the relevant flags (e.g., "install -s" is not used). If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_preserve_debug]

    This is covered by the python build system, there are no additional verbose/debugging information that isn't preserved.



    The build system for the software produced by the project MUST NOT recursively build subdirectories if there are cross-dependencies in the subdirectories. If there is no build or installation system (e.g., typical JavaScript libraries), select "not applicable" (N/A). [build_non_recursive]

    This is covered by the JIT compilation, these directories are not built if not specified.



    The project MUST be able to repeat the process of generating information from source files and get exactly the same bit-for-bit result. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). [build_repeatable]

    Identical builds from the same commit/command/environment is guaranteed based on the build flow, there is no randomness/etc.


  • Installation system


    The project MUST provide a way to easily install and uninstall the software produced by the project using a commonly-used convention. [installation_common]

    This is covered by python, just pip uninstall deepspeed even if installed from PyPI or built from source.



    The installation system for end-users MUST honor standard conventions for selecting the location where built artifacts are written to at installation time. For example, if it installs files on a POSIX system it MUST honor the DESTDIR environment variable. If there is no installation system or no standard convention, select "not applicable" (N/A). [installation_standard_variables]

    This project meets the python standard conventions for build locations and artifacts.



    The project MUST provide a way for potential developers to quickly install all the project results and support environment necessary to make changes, including the tests and test environment. This MUST be performed with a commonly-used convention. [installation_development_quick]

    This is covered by the python packages and dependencies, just pip install deepspeed or it can easily be built quickly.


  • Externally-maintained components


    The project MUST list external dependencies in a computer-processable way. (URL required) [external_dependencies]

    These are listed in the requirements files in the requirements folder: https://github.com/microsoft/DeepSpeed/tree/master/requirements

    The only potential issue is that torch is required to be installed before deepspeed and there is no computer processable way to confirm this.



    Projects MUST monitor or periodically check their external dependencies (including convenience copies) to detect known vulnerabilities, and fix exploitable vulnerabilities or verify them as unexploitable. [dependency_monitoring]

    This is currently done via GitHub alerting us as well as collaboration with those projects.



    The project MUST either:
    1. make it easy to identify and update reused externally-maintained components; or
    2. use the standard components provided by the system or programming language.
    Then, if a vulnerability is found in a reused component, it will be easy to update that component. [updateable_reused_components]

    The external dependencies can easily be updated by creating a PR and modifying the requirements.txt (or equivalent file). The standard components from python are also used, but where not possible, the other python packages can easily be updated and re-built with via the requirements file.



    The project SHOULD avoid using deprecated or obsolete functions and APIs where FLOSS alternatives are available in the set of technology it uses (its "technology stack") and to a supermajority of the users the project supports (so that users have ready access to the alternative). [interfaces_current]

    The only non-FLOSS software that is depended upon is CUDA but that is only a requirement on Nvidia GPUs. The python packages don't rely on any deprecated or obsolete functions.


  • Automated test suite


    An automated test suite MUST be applied on each check-in to a shared repository for at least one branch. This test suite MUST produce a report on test success or failure. [automated_integration_testing]

    Tests and requirements including code review by at least one other person are required for the master branch. This requires formatting, python checks, as well as unit tests in a number of different files:

    test yml files located here: https://github.com/microsoft/DeepSpeed/tree/master/.github/workflows



    The project MUST add regression tests to an automated test suite for at least 50% of the bugs fixed within the last six months. [regression_tests_added50]

    Regression tests are added and normal CI tests are run nightly as well (with bugs/issues opening new GitHub issues to be easier to track)

    Sample nightly CI: https://github.com/microsoft/DeepSpeed/blob/master/.github/workflows/nv-nightly.yml Other nightly tests: https://github.com/microsoft/DeepSpeed/blob/master/.github/workflows/nv-torch-latest-v100.yml#L14C1-L14C24

    Sample opening bug if regression tests fail: https://github.com/microsoft/DeepSpeed/blob/c7f58c899f6f099a35d968bdad973f24b842c8c6/.github/workflows/nv-sd.yml#L67C1-L73C64



    The project MUST have FLOSS automated test suite(s) that provide at least 80% statement coverage if there is at least one FLOSS tool that can measure this criterion in the selected language. [test_statement_coverage80]

    pytest coverage is used, .coveragerc is here: https://github.com/microsoft/DeepSpeed/blob/c7f58c899f6f099a35d968bdad973f24b842c8c6/tests/.coveragerc#L3

    Coverage is output via the GitHub Actions UI


  • New functionality testing


    The project MUST have a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite. [test_policy_mandated]

    This is covered in the New Feature Contribution Guidelines listed here: https://github.com/microsoft/DeepSpeed/blob/master/CONTRIBUTING.md#new-feature-contribution-guidelines



    The project MUST include, in its documented instructions for change proposals, the policy that tests are to be added for major new functionality. [tests_documented_added]

    This is also covered in the New Feature Contribution Guidelines section 2: Implementation and verification: https://github.com/microsoft/DeepSpeed/blob/master/CONTRIBUTING.md#step-2-implementation-and-verification


  • Banderas de advertencia


    Projects MUST be maximally strict with warnings in the software produced by the project, where practical. [warnings_strict]

    New errors must be addressed and old errors are slowly being resolved.


  • Conocimiento de desarrollo seguro


    The project MUST implement secure design principles (from "know_secure_design"), where applicable. If the project is not producing software, select "not applicable" (N/A). [implement_secure_design]

    This is done to the best of our knowledge, defaults are sane, and the software has been checked by Microsoft's Open Source Security team for secure design decisions.


  • Use buenas prácticas criptográficas

    Note that some software does not need to use cryptographic mechanisms. If your project produces software that (1) includes, activates, or enables encryption functionality, and (2) might be released from the United States (US) to outside the US or to a non-US-citizen, you may be legally required to take a few extra steps. Typically this just involves sending an email. For more information, see the encryption section of Understanding Open Source Technology & US Export Controls.

    The default security mechanisms within the software produced by the project MUST NOT depend on cryptographic algorithms or modes with known serious weaknesses (e.g., the SHA-1 cryptographic hash algorithm or the CBC mode in SSH). [crypto_weaknesses]


    The project SHOULD support multiple cryptographic algorithms, so users can quickly switch if one is broken. Common symmetric key algorithms include AES, Twofish, and Serpent. Common cryptographic hash algorithm alternatives include SHA-2 (including SHA-224, SHA-256, SHA-384 AND SHA-512) and SHA-3. [crypto_algorithm_agility]

    The software doesn't support cryptographic algorithms on its own, there is no need for a user to specify an algorithm.



    The project MUST support storing authentication credentials (such as passwords and dynamic tokens) and private cryptographic keys in files that are separate from other information (such as configuration files, databases, and logs), and permit users to update and replace them without code recompilation. If the project never processes authentication credentials and private cryptographic keys, select "not applicable" (N/A). [crypto_credential_agility]

    The project does not interact with these credentials, only relies on other software like HuggingFace Hub for example.



    The software produced by the project SHOULD support secure protocols for all of its network communications, such as SSHv2 or later, TLS1.2 or later (HTTPS), IPsec, SFTP, and SNMPv3. Insecure protocols such as FTP, HTTP, telnet, SSLv3 or earlier, and SSHv1 SHOULD be disabled by default, and only enabled if the user specifically configures it. If the software produced by the project does not support network communications, select "not applicable" (N/A). [crypto_used_network]

    The project does not output its own security software so there is no need for these protocols.



    The software produced by the project SHOULD, if it supports or uses TLS, support at least TLS version 1.2. Note that the predecessor of TLS was called SSL. If the software does not use TLS, select "not applicable" (N/A). [crypto_tls12]

    The software does not output any code that would need to rely on TLS.



    The software produced by the project MUST, if it supports TLS, perform TLS certificate verification by default when using TLS, including on subresources. If the software does not use TLS, select "not applicable" (N/A). [crypto_certificate_verification]

    The software does not use/require TLS, but the website does support TLS 1.2.



    The software produced by the project MUST, if it supports TLS, perform certificate verification before sending HTTP headers with private information (such as secure cookies). If the software does not use TLS, select "not applicable" (N/A). [crypto_verification_private]

    Software output by DeepSpeed does not require TLS.


  • Secure release


    The project MUST cryptographically sign releases of the project results intended for widespread use, and there MUST be a documented process explaining to users how they can obtain the public signing keys and verify the signature(s). The private key for these signature(s) MUST NOT be on site(s) used to directly distribute the software to the public. If releases are not intended for widespread use, select "not applicable" (N/A). [signed_releases]

    Releases are securely uploaded to PyPI, this can be verified by PyPI and by using the official upload to PyPI GitHub action.



    It is SUGGESTED that in the version control system, each important version tag (a tag that is part of a major release, minor release, or fixes publicly noted vulnerabilities) be cryptographically signed and verifiable as described in signed_releases. [version_tags_signed]

    All releases are tagged and pushed to git, and the .whl builds are pushed to PyPI, but the tags themselves are not cryptographically signed by anything other than what is provided by GitHub.


  • Otros problemas de seguridad


    The project results MUST check all inputs from potentially untrusted sources to ensure they are valid (an *allowlist*), and reject invalid inputs, if there are any restrictions on the data at all. [input_validation]

    This is not applicable due to the nature of the project and what it does.



    Hardening mechanisms SHOULD be used in the software produced by the project so that software defects are less likely to result in security vulnerabilities. [hardening]

    This is covered by input parsing and validation of inputs, and the fact that the software wraps torch.



    The project MUST provide an assurance case that justifies why its security requirements are met. The assurance case MUST include: a description of the threat model, clear identification of trust boundaries, an argument that secure design principles have been applied, and an argument that common implementation security weaknesses have been countered. (URL required) [assurance_case]

  • Análisis estático de código


    The project MUST use at least one static analysis tool with rules or approaches to look for common vulnerabilities in the analyzed language or environment, if there is at least one FLOSS tool that can implement this criterion in the selected language. [static_analysis_common_vulnerabilities]

    PyFlake/Flake8/MyPy are all run in the pre-commit formatting/run on all PRs: https://github.com/microsoft/DeepSpeed/blob/master/.pre-commit-config.yaml


  • Dynamic code analysis


    If the software produced by the project includes software written using a memory-unsafe language (e.g., C or C++), then at least one dynamic tool (e.g., a fuzzer or web application scanner) MUST be routinely used in combination with a mechanism to detect memory safety problems such as buffer overwrites. If the project does not produce software written in a memory-unsafe language, choose "not applicable" (N/A). [dynamic_analysis_unsafe]

    We do ship C++ binaries and these should soon be covered as above, we haven't added this coverage yet thought. Though these are cuda style kernels and cannot be fuzzed independently of the main DeepSpeed program.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Logan Adams and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Logan Adams.
Entry created on 2024-10-07 17:38:47 UTC, last updated on 2025-01-16 18:47:52 UTC. Last achieved passing badge on 2024-10-07 19:58:32 UTC.

Back