engine.h

// 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 _ST_HPC_PPL_NN_ENGINES_ENGINE_H_
#define _ST_HPC_PPL_NN_ENGINES_ENGINE_H_

#include "ppl/common/retcode.h"
#include "ppl/nn/common/common.h"

namespace ppl { namespace nn {

/**
   @class Engine
   @brief collection of op implementations
*/
class PPLNN_PUBLIC Engine {
public:
    virtual ~Engine() {}

    /** @brief get engine's name */
    virtual const char* GetName() const = 0;

    /** @brief various configurations. see `engines/<engname>/<engname>_options.h` for details. */
    virtual ppl::common::RetCode Configure(uint32_t, ...) = 0;
};

}} // namespace ppl::nn

#endif