include/mxnet/c_api_test.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.
 */

/*!
 * \file c_api_test.h
 * \brief C API of mxnet for ease of testing backend in Python
 */
#ifndef MXNET_C_API_TEST_H_
#define MXNET_C_API_TEST_H_

/*! \brief Inhibit C++ name-mangling for MXNet functions. */
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus

#include <mxnet/c_api.h>

/*!
 * \brief This API partitions a graph only by the operator names
 * provided by users. This will attach a DefaultSubgraphProperty
 * to the input graph for partitioning. This function should be
 * used only for the testing purpose.
 */
MXNET_DLL int MXBuildSubgraphByOpNames(SymbolHandle sym_handle,
                                        const char* prop_name,
                                        const uint32_t num_ops,
                                        const char** op_names,
                                        SymbolHandle* ret_sym_handle);

/*!
 * \brief Given a subgraph property name, use the provided op names
 * as the op_names attribute for that subgraph property, instead of
 * the predefined one. This is only for the purpose of testing.
 */
MXNET_DLL int MXSetSubgraphPropertyOpNames(const char* prop_name,
                                           const uint32_t num_ops,
                                           const char** op_names);

/*!
 * \brief Given a subgraph property name, use the provided op names
 * as the op_names attribute for that subgraph property, instead of
 * the predefined one. This is only for the purpose of testing.
 * Compared to MXSetSubgraphPropertyOpNames(), this API will add
 * op_names to the backend property.
 */
MXNET_DLL int MXSetSubgraphPropertyOpNamesV2(const char* prop_name,
                                           const uint32_t num_ops,
                                           const char** op_names);
/*!
 * \brief Given a subgraph property name, delete the op name set
 * in the SubgraphPropertyOpNameSet.
 */
MXNET_DLL int MXRemoveSubgraphPropertyOpNames(const char* prop_name);
/*!
 * \brief Given a subgraph property name, remove op_names attribute of
 * the in the SubgraphBackend property.
 */
MXNET_DLL int MXRemoveSubgraphPropertyOpNamesV2(const char* prop_name);


/*!
 * \brief Get the value of an environment variable as seen by the backend.
 * \param name The name of the environment variable
 * \param value The returned value of the environment variable
 */
MXNET_DLL int MXGetEnv(const char* name,
                       const char** value);

/*!
 * \brief Set the value of an environment variable from the backend.
 * \param name The name of the environment variable
 * \param value The desired value to set the environment variable `name`
 */
MXNET_DLL int MXSetEnv(const char* name,
                       const char* value);

#ifdef __cplusplus
}
#endif  // __cplusplus

#endif  // MXNET_C_API_TEST_H_