tvm
on_device.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
24 #ifndef TVM_RELAY_ATTRS_ON_DEVICE_H_
25 #define TVM_RELAY_ATTRS_ON_DEVICE_H_
26 
27 #include <tvm/ir/attrs.h>
29 
30 #include <string>
31 
32 namespace tvm {
33 namespace relay {
34 
61 struct OnDeviceAttrs : public tvm::AttrsNode<OnDeviceAttrs> {
67 
72  bool constrain_result = false;
73 
78  bool constrain_body = true;
79 
83  bool is_fixed() const { return constrain_result && constrain_body; }
84 
88  bool is_normal() const { return !constrain_result && constrain_body; }
89 
90  TVM_DECLARE_ATTRS(OnDeviceAttrs, "relay.attrs.OnDeviceAttrs") {
92  .describe("The (virtual) device to constrain to.")
93  .set_default(VirtualDevice::FullyUnconstrained());
95  .describe("Whether the constraint applies to the overall expression")
96  .set_default(false);
98  .describe("Whether the constraint applies to the body sub-expression.")
99  .set_default(true);
100  }
101 };
102 
103 } // namespace relay
104 } // namespace tvm
105 
106 #endif // TVM_RELAY_ATTRS_ON_DEVICE_H_
The base class of the all the Use "curiously recurring template pattern".
Definition: attrs.h:870
Managed reference class to VirtualDeviceNode.
Definition: virtual_device.h:271
static VirtualDevice FullyUnconstrained()
Returns the unique fully unconstrained VirtualDevice.
Helpers for attribute objects.
#define TVM_ATTR_FIELD(FieldName)
Declare an attribute field.
Definition: attrs.h:76
runtime implementation for LibTorch/TorchScript.
Definition: analyzer.h:36
Attributes for the "on_device" annotation (ie operator).
Definition: on_device.h:61
bool constrain_result
If false (the default), the result of the "on_device" call is not constrained to be virtual_device.
Definition: on_device.h:72
bool is_fixed() const
Returns true if both the body and result are constrained.
Definition: on_device.h:83
TVM_DECLARE_ATTRS(OnDeviceAttrs, "relay.attrs.OnDeviceAttrs")
Definition: on_device.h:90
bool is_normal() const
Returns true only the body is constrained (the 'normal' case).
Definition: on_device.h:88
VirtualDevice virtual_device
The VirtualDevice to constraint to apply to the body, result, or both body and result of the "on_devi...
Definition: on_device.h:66
bool constrain_body
If true (the default), the body of the "on_device" call is constrained to be virtual_device.
Definition: on_device.h:78
A compile time representation for where data is to be stored at runtime, and how to compile code to c...