op_attr_types.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 NNVM_OP_ATTR_TYPES_H_
#define NNVM_OP_ATTR_TYPES_H_
 
#include <functional>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
#include "base.h"
#include "layout.h"
#include "node.h"
#include "tuple.h"
 
namespace nnvm {
 
// These types are optional attributes in each operator.
// Each attribute can be required by some passes.
 
using FListInputNames = std::function<std::vector<std::string>(const NodeAttrs& attrs)>;
 
using FNumVisibleOutputs = std::function<uint32_t(const NodeAttrs& attrs)>;
 
using FListOutputNames = std::function<std::vector<std::string>(const NodeAttrs& attrs)>;
 
using FMutateInputs = std::function<std::vector<uint32_t>(const NodeAttrs& attrs)>;
 
template <typename AttrType>
using FInferNodeEntryAttr = std::function<bool(
    const NodeAttrs& attrs, std::vector<AttrType>* in_attrs, std::vector<AttrType>* out_attrs)>;
 
using FGetAttrDict =
    std::function<std::unordered_map<std::string, std::string>(const NodeAttrs& attrs)>;
 
using FInferShape = FInferNodeEntryAttr<TShape>;
 
using FInferType = FInferNodeEntryAttr<int>;
 
using TIsBackward = bool;
 
using TIsGhost = bool;
 
using FInplaceOption = std::function<std::vector<std::pair<int, int> >(const NodeAttrs& attrs)>;
 
using FInplaceIdentity = std::function<std::vector<bool>(const NodeAttrs& attrs)>;
 
using FIgnoreInputs = std::function<std::vector<uint32_t>(const NodeAttrs& attrs)>;
 
using FGradient = std::function<std::vector<NodeEntry>(const ObjectPtr& nodeptr,
                                                       const std::vector<NodeEntry>& out_grads)>;
 
using FSetInputVarAttrOnCompose =
    std::function<void(const NodeAttrs& attrs, ObjectPtr var, const int index)>;
 
using FCorrectLayout =
    std::function<bool(const NodeAttrs& attrs, std::vector<Layout>* ilayouts,
                       const std::vector<Layout>* last_ilayouts, std::vector<Layout>* olayouts)>;
 
using FInputGraph = std::function<std::vector<uint32_t>(const NodeAttrs& attrs)>;
 
}  // namespace nnvm
 
#endif  // NNVM_OP_ATTR_TYPES_H_