1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright 2016 Google Inc.
//
// 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.!
#ifndef MODEL_INTERFACE_H_
#define MODEL_INTERFACE_H_
#include <memory>
#include <set>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
#include "common.h"
#include "normalizer.h"
#include "sentencepiece_model.pb.h"
#include "sentencepiece_processor.h"
#include "third_party/absl/strings/string_view.h"
#include "third_party/darts_clone/darts.h"
#include "util.h"
namespace sentencepiece {
// "_this_is_a_pen" => ["_this", "_is", "_a", "_pen"]
std::vector<absl::string_view> SplitIntoWords(absl::string_view text);
using EncodeResult = std::vector<std::pair<absl::string_view, int>>;
using NBestEncodeResult = std::vector<std::pair<EncodeResult, float>>;
class ModelProto;
// Underlying model interface.
// Given a normalized string, returns a sequence of sentence pieces with ids.
class ModelInterface {
public:
using PieceToIdMap =
std::unordered_map<absl::string_view, int, string_util::string_view_hash>;
absl::string_view unk_piece() const;
absl::string_view bos_piece() const;
absl::string_view eos_piece() const;
absl::string_view pad_piece() const;
// `model_proto` should not be deleted until ModelInterface is destroyed.
explicit ModelInterface(const ModelProto &model_proto);
ModelInterface() {}
virtual ~ModelInterface();
// Returns Status.
// Encode/Decode functions are valid only when status is OK.
virtual util::Status status() const { return status_; }
virtual const ModelProto &model_proto() const { return *model_proto_; }
virtual const normalizer::PrefixMatcher *prefix_matcher() const {
return matcher_.get();
}
// Given a normalized string, returns a sequence of sentence pieces with ids.
// The concatenation of pieces must be the same as `normalized`.
virtual EncodeResult Encode(absl::string_view normalized) const = 0;
// The same as above, but returns nbest result with score.
virtual NBestEncodeResult NBestEncode(absl::string_view normalized,
int nbest_size) const {
LOG(ERROR) << "Not implemented.";
return NBestEncodeResult();
}
virtual EncodeResult SampleEncode(absl::string_view normalized,
float alpha) const {
LOG(ERROR) << "Not implemented.";
return EncodeResult();
}
// Returns the vocab id of `piece`.
// Returns UNK(0) if `piece` is unknown
virtual int PieceToId(absl::string_view piece) const;
// Returns the string representation of vocab with `id`.
// id must be 0 <= id < GetPieceSize().
virtual const std::string &IdToPiece(int id) const {
return model_proto_->pieces(id).piece();
}
// Returns the size of sentence pieces, which is the same
// as the size of vocabulary for NMT.
virtual int GetPieceSize() const { return model_proto_->pieces_size(); }
// Returns the score of `id`.
// Score represents a log probability of the piece.
// We can roughly estimate the unigram frequency of the piece.
virtual float GetScore(int id) const {
return model_proto_->pieces(id).score();
}
// Returns true if `id` is unknown symbol.
virtual bool IsUnknown(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::UNKNOWN);
}
// Returns true if `id` is control symbol.
virtual bool IsControl(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::CONTROL);
}
// Returns true if `id` is unused symbol.
virtual bool IsUnused(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::UNUSED);
}
// Returns true if `id` is user defined symbol.
virtual bool IsUserDefined(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::USER_DEFINED);
}
protected:
void InitializePieces();
// Non-virtual (inlined) implementation for faster execution.
inline float GetScoreInlined(int id) const {
return model_proto_->pieces(id).score();
}
inline bool IsUnknownInlined(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::UNKNOWN);
}
inline bool IsControlInlined(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::CONTROL);
}
inline bool IsUnusedInlined(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::UNUSED);
}
inline bool IsUserDefinedInlined(int id) const {
return (model_proto_->pieces(id).type() ==
ModelProto::SentencePiece::USER_DEFINED);
}
const ModelProto *model_proto_ = nullptr;
// PrefixMatcher for user defined symbols.
std::unique_ptr<normalizer::PrefixMatcher> matcher_;
// piece -> id map for normal pieces
PieceToIdMap pieces_;
// piece -> id map for control and unknown
PieceToIdMap reserved_id_map_;
// unknown id.
int unk_id_ = 0;
// status.
util::Status status_;
};
} // namespace sentencepiece
#endif // MODEL_INTERFACE_H_
|
