Program Listing for File multi_response.hpp

            

            
/*
* SPDX-FileCopyrightText: Copyright (c) 2021-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*
* Licensed 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.
*/

#pragma once

#include "morpheus/export.h"
#include "morpheus/messages/memory/tensor_memory.hpp"
#include "morpheus/messages/meta.hpp"
#include "morpheus/messages/multi.hpp"
#include "morpheus/messages/multi_tensor.hpp"
#include "morpheus/objects/tensor_object.hpp"
#include "morpheus/types.hpp" // for TensorIndex

#include <pybind11/pytypes.h>

#include <memory>
#include <string>

namespace morpheus {
/****** Component public implementations *******************/
/****** MultiResponseMessage****************************************/

class MORPHEUS_EXPORT MultiResponseMessage : public DerivedMultiMessage<MultiResponseMessage, MultiTensorMessage>
{
  public:
    MultiResponseMessage(const MultiResponseMessage& other) = default;

    MultiResponseMessage(std::shared_ptr<MessageMeta> meta,
                         TensorIndex mess_offset              = 0,
                         TensorIndex mess_count               = -1,
                         std::shared_ptr<TensorMemory> memory = nullptr,
                         TensorIndex offset                   = 0,
                         TensorIndex count                    = -1,
                         std::string id_tensor_name           = "seq_ids",
                         std::string probs_tensor_name        = "probs");

    std::string probs_tensor_name;

    const TensorObject get_output(const std::string& name) const;

    TensorObject get_output(const std::string& name);

    void set_output(const std::string& name, const TensorObject& value);

    TensorObject get_probs_tensor() const;
};

/****** MultiResponseMessageInterfaceProxy *************************/
struct MORPHEUS_EXPORT MultiResponseMessageInterfaceProxy : public MultiTensorMessageInterfaceProxy
{
    static std::shared_ptr<MultiResponseMessage> init(std::shared_ptr<MessageMeta> meta,
                                                      TensorIndex mess_offset,
                                                      TensorIndex mess_count,
                                                      std::shared_ptr<TensorMemory> memory,
                                                      TensorIndex offset,
                                                      TensorIndex count,
                                                      std::string id_tensor_name,
                                                      std::string probs_tensor_name);

    static std::string probs_tensor_name_getter(MultiResponseMessage& self);

    static void probs_tensor_name_setter(MultiResponseMessage& self, std::string probs_tensor_name);

    static pybind11::object get_output(MultiResponseMessage& self, const std::string& name);

    static pybind11::object get_probs_tensor(MultiResponseMessage& self);
};  // end of group
}  // namespace morpheus