ExecutionEngine.h 2.5 KB
Newer Older
J
jinhai 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// 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.

X
Xu Peng 已提交
18 19
#pragma once

S
starlord 已提交
20
#include "utils/Status.h"
21

X
Xu Peng 已提交
22
#include <memory>
S
starlord 已提交
23
#include <string>
S
starlord 已提交
24
#include <vector>
X
Xu Peng 已提交
25

J
jinhai 已提交
26
namespace milvus {
X
Xu Peng 已提交
27 28
namespace engine {

G
groot 已提交
29
enum class EngineType {
G
groot 已提交
30
    INVALID = 0,
G
groot 已提交
31 32
    FAISS_IDMAP = 1,
    FAISS_IVFFLAT,
S
starlord 已提交
33
    FAISS_IVFSQ8,
X
xj.lin 已提交
34
    NSG_MIX,
W
wxyu 已提交
35 36
    FAISS_IVFSQ8H,
    MAX_VALUE = FAISS_IVFSQ8H,
G
groot 已提交
37 38
};

39 40 41 42 43
enum class MetricType {
    L2 = 1,
    IP = 2,
};

44
class ExecutionEngine {
S
starlord 已提交
45
 public:
S
starlord 已提交
46 47
    virtual Status
    AddWithIds(int64_t n, const float* xdata, const int64_t* xids) = 0;
48

S
starlord 已提交
49 50
    virtual size_t
    Count() const = 0;
51

S
starlord 已提交
52 53
    virtual size_t
    Size() const = 0;
54

S
starlord 已提交
55 56
    virtual size_t
    Dimension() const = 0;
G
groot 已提交
57

S
starlord 已提交
58 59
    virtual size_t
    PhysicalSize() const = 0;
60

S
starlord 已提交
61 62
    virtual Status
    Serialize() = 0;
63

S
starlord 已提交
64 65
    virtual Status
    Load(bool to_cache = true) = 0;
66

S
starlord 已提交
67 68
    virtual Status
    CopyToGpu(uint64_t device_id) = 0;
69

Y
Yu Kun 已提交
70 71 72
    virtual Status
    CopyToIndexFileToGpu(uint64_t device_id) = 0;

S
starlord 已提交
73 74
    virtual Status
    CopyToCpu() = 0;
75

S
starlord 已提交
76 77
    virtual std::shared_ptr<ExecutionEngine>
    Clone() = 0;
W
wxyu 已提交
78

S
starlord 已提交
79 80
    virtual Status
    Merge(const std::string& location) = 0;
81

S
starlord 已提交
82 83
    virtual Status
    Search(int64_t n, const float* data, int64_t k, int64_t nprobe, float* distances, int64_t* labels) const = 0;
84

S
starlord 已提交
85 86
    virtual std::shared_ptr<ExecutionEngine>
    BuildIndex(const std::string& location, EngineType engine_type) = 0;
87

S
starlord 已提交
88 89
    virtual Status
    Cache() = 0;
Y
yu yunfeng 已提交
90

S
starlord 已提交
91 92
    virtual Status
    GpuCache(uint64_t gpu_id) = 0;
Y
Yu Kun 已提交
93

S
starlord 已提交
94 95
    virtual Status
    Init() = 0;
S
starlord 已提交
96

S
starlord 已提交
97 98
    virtual EngineType
    IndexEngineType() const = 0;
S
starlord 已提交
99

S
starlord 已提交
100 101
    virtual MetricType
    IndexMetricType() const = 0;
102

S
starlord 已提交
103 104
    virtual std::string
    GetLocation() const = 0;
105 106
};

G
groot 已提交
107 108
using ExecutionEnginePtr = std::shared_ptr<ExecutionEngine>;

S
starlord 已提交
109 110
}  // namespace engine
}  // namespace milvus