Skip to content

include/tenzr/frontend/sharding.h

Namespaces

Name
tenzr

Classes

Name
class tenzr::ShardingSpec

Source code

// Copyright 2026 The Tenzr Project Authors
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef TENZR_FRONTEND_SHARDING_H_
#define TENZR_FRONTEND_SHARDING_H_

#include <cstdint>
#include <string>
#include <vector>

namespace tenzr {

  enum class ShardingType { kReplicated, kTiled, kManual };

  class NamedSharding;

  class ShardingSpec {
   public:
    ShardingSpec() : type_(ShardingType::kReplicated) {}

    explicit ShardingSpec(const NamedSharding& ns);

    static ShardingSpec Replicated();

    static ShardingSpec Tiled(std::vector<int64_t> mesh_shape, std::vector<int> tensor_dim_to_mesh_axis);

    ShardingType type() const { return type_; }

    bool IsReplicated() const { return type_ == ShardingType::kReplicated; }

    bool IsTiled() const { return type_ == ShardingType::kTiled; }

    const std::vector<int64_t>& MeshShape() const { return mesh_shape_; }

    const std::vector<int>& DimToAxis() const { return tensor_dim_to_mesh_axis_; }

    std::string ToString() const;

    std::string ToShardingAttribute() const;

   private:
    ShardingType type_{ShardingType::kReplicated};
    std::vector<int64_t> mesh_shape_;
    std::vector<int> tensor_dim_to_mesh_axis_;
  };

}  // namespace tenzr

#endif  // TENZR_FRONTEND_SHARDING_H_