ct2rs 0.9.18

Rust bindings for OpenNMT/CTranslate2
Documentation 
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

#pragma once

#include <istream>
#include <memory>
#include <string>
#include <vector>

#include "utils.h"

namespace ctranslate2 {

  enum class BatchType {
    Examples,
    Tokens,
  };

  BatchType str_to_batch_type(const std::string& batch_type);


  // An example is a collection of sequences or streams (e.g. source and target).
  struct Example {
    std::vector<std::vector<std::string>> streams;

    Example() = default;

    Example(std::vector<std::string> sequence) {
      streams.emplace_back(std::move(sequence));
    }

    Example(std::vector<std::string> source, std::vector<std::string> target) {
      streams.reserve(2);
      streams.emplace_back(std::move(source));
      streams.emplace_back(std::move(target));
    }

    size_t num_streams() const {
      return streams.size();
    }

    bool empty() const {
      return streams.empty();
    }

    size_t length(size_t index = 0) const {
      if (index >= streams.size())
        return 0;
      return streams[index].size();
    }
  };


  // Base class to produce batches.
  class BatchReader {
  public:
    virtual ~BatchReader() = default;

    std::vector<Example>
    get_next(const size_t max_batch_size,
             const BatchType batch_type = BatchType::Examples,
             const bool consider_padding = false);

    // Consumes and returns the next example.
    virtual Example get_next_example() = 0;

    // Returns the total number of examples, or 0 if not known.
    virtual size_t num_examples() const {
      return 0;
    }

  private:
    std::vector<Example> fill_batch_with_fixed_increment(const size_t max_batch_size,
                                                          const BatchType batch_type);

    std::vector<Example> fill_batch_with_variable_increment(const size_t max_batch_size,
                                                             const BatchType batch_type);

    bool _initialized = false;
    Example _next;
  };

  // Read batches from a stream.
  template <typename Tokenizer>
  class TextLineReader : public BatchReader {
  public:
    TextLineReader(std::istream& stream, Tokenizer& tokenizer)
      : _stream(stream)
      , _tokenizer(tokenizer)
    {
    }

    Example get_next_example() override {
      Example example;

      std::string line;
      if (ctranslate2::getline(_stream, line))
        example.streams.emplace_back(_tokenizer(line));

      return example;
    }

  private:
    std::istream& _stream;
    Tokenizer& _tokenizer;
  };

  // Read batches from a vector of examples.
  class VectorReader : public BatchReader {
  public:
    VectorReader(std::vector<std::vector<std::string>> examples);
    VectorReader(std::vector<Example> examples);

    Example get_next_example() override;
    size_t num_examples() const override {
      return _examples.size();
    }

  private:
    std::vector<Example> _examples;
    size_t _index = 0;
  };

  // Read batches from multiple sources.
  class ParallelBatchReader : public BatchReader {
  public:
    void add(std::unique_ptr<BatchReader> reader);

    Example get_next_example() override;
    size_t num_examples() const override;

  private:
    std::vector<std::unique_ptr<BatchReader>> _readers;
  };


  struct Batch {
    std::vector<Example> examples;
    std::vector<size_t> example_index;  // Index of each example in the original input.

    size_t num_examples() const {
      return examples.size();
    }

    bool empty() const {
      return examples.empty();
    }

    std::vector<std::vector<std::string>> get_stream(size_t index) const;
  };


  std::vector<Example>
  load_examples(std::vector<std::vector<std::vector<std::string>>> streams);

  // Rebatch the input with a new batch size.
  // This function also reorders the examples to improve efficiency.
  std::vector<Batch>
  rebatch_input(const std::vector<Example>& examples,
                size_t max_batch_size = 0,
                BatchType batch_type = BatchType::Examples);

}