struct_info.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 *
 *   http://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 TVM_RELAX_DISTRIBUTED_STRUCT_INFO_H_
#define TVM_RELAX_DISTRIBUTED_STRUCT_INFO_H_
 
#include <tvm/relax/distributed/global_info.h>
#include <tvm/relax/struct_info.h>
namespace tvm {
namespace relax {
namespace distributed {
 
enum class PlacementSpecKind : int { kSharding = 0, kReplica = 1 };
 
class PlacementSpecNode : public Object {
 public:
  int axis;
 
  PlacementSpecKind kind;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PlacementSpecNode>()
        .def_ro("axis", &PlacementSpecNode::axis)
        .def_ro("kind", &PlacementSpecNode::kind);
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindConstTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO("relax.distributed.PlacementSpec", PlacementSpecNode, Object);
};
 
class PlacementSpec : public ObjectRef {
 public:
  TVM_DLL static PlacementSpec Sharding(int axis);
 
  TVM_DLL static PlacementSpec Replica();
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PlacementSpec, ObjectRef, PlacementSpecNode);
};
 
class ShardingNode : public PlacementSpecNode {
 public:
  Integer sharding_dim;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<ShardingNode>().def_ro("sharding_dim", &ShardingNode::sharding_dim);
  }
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.distributed.Sharding", ShardingNode, PlacementSpecNode);
};
 
class PlacementNode : public Object {
 public:
  ffi::Array<PlacementSpec> dim_specs;
 
  ffi::String ToString() const;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PlacementNode>().def_ro("dim_specs", &PlacementNode::dim_specs);
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindConstTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.distributed.Placement", PlacementNode, Object);
};
 
class Placement : public ObjectRef {
 public:
  TVM_DLL explicit Placement(ffi::Array<PlacementSpec> dim_specs);
  static Placement FromText(ffi::String text_repr);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(Placement, ObjectRef, PlacementNode);
};
 
class DTensorStructInfoNode : public StructInfoNode {
 public:
  TensorStructInfo tensor_sinfo;
  DeviceMesh device_mesh;
  Placement placement;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<DTensorStructInfoNode>()
        .def_ro("device_mesh", &DTensorStructInfoNode::device_mesh)
        .def_ro("placement", &DTensorStructInfoNode::placement)
        .def_ro("tensor_sinfo", &DTensorStructInfoNode::tensor_sinfo);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.DTensorStructInfo", DTensorStructInfoNode,
                                    StructInfoNode);
};
 
class DTensorStructInfo : public StructInfo {
 public:
  TVM_DLL DTensorStructInfo(TensorStructInfo tensor_sinfo, DeviceMesh device_mesh,
                            Placement placement, Span span = Span());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(DTensorStructInfo, StructInfo, DTensorStructInfoNode);
};
 
}  // namespace distributed
}  // namespace relax
}  // namespace tvm
 
#endif  // TVM_RELAX_DISTRIBUTED_STRUCT_INFO_H_