Install FlagScale

Contents

Install FlagScale#

Read Requirements before proceeding.

Steps#

  1. Install FlagScale: {style=lower-alpha}

    1. From source

      git clone https://github.com/flagos-ai/FlagScale.git
      cd FlagScale
      pip install . --verbose
      
    2. Via pip.

      pip install flagscale --extra-index-url https://resource.flagos.net/repository/flagos-pypi-hosted/simple
      
  2. Install backends as needed:

    • Inference and serving backend:

    Install vLLM-plugin-FL.

    pip install vllm==0.13.0
    pip install vllm-plugin-fl==0.1.0+vllm0.13.0 --extra-index-url https://resource.flagos.net/repository/flagos-pypi-hosted/simple
    

    You may need to install other FlagOS components. For more information, see vLLM-plugin-FL.

    • Training backend:

      Install Megatron-LM-FL.

      pip install megatron_core==0.1.0+megatron0.15.0rc7 --extra-index-url https://resource.flagos.net/repository/flagos-pypi-hosted/simple
      

      For more information, see Megatron-LM-FL.

      Install TransformerEngine-FL.

      pip install transformer_engine==0.1.0+te2.9.0 --extra-index-url https://resource.flagos.net/repository/flagos-pypi-hosted/simple
      

    For more information, see TransformerEngine-FL.

    • Reinforce learning backend:

      Install verl-FL.

      pip install verl==0.1.0+verl0.7.0 --extra-index-url https://resource.flagos.net/repository/flagos-pypi-hosted/simple
      

    To get full installation instructions, see verl-FL.

  3. Verify FlagScale installation

pip show flagscale