helpers.cpp 9.23 KB
Newer Older
1
/* Helper methods for fast index mapping builds */
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
2
3
4
5
6

#include <algorithm>
#include <iostream>
#include <limits>
#include <math.h>
7
#include <stdexcept>
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
8
9
#include <pybind11/pybind11.h>
#include <pybind11/numpy.h>
10
#include <random>
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
11
12
13
14
15

namespace py = pybind11;
using namespace std;


16
17
18
inline int32_t get_target_sample_len(const int32_t short_seq_ratio,
				     const int32_t max_length,
				     std::mt19937& rand32_gen) {
19
    /* Training sample length. */
20
    const auto random_number = rand32_gen();
21
    if ((random_number % short_seq_ratio) == 0) {
22
      return 2 + random_number % (max_length - 1);
23
24
    }
    return max_length;
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
25
26
}

27

28
template<typename DocIdx>
29
30
31
py::array build_mapping_impl(const py::array_t<int64_t>& docs_,
                             const py::array_t<int32_t>& sizes_,
                             const int32_t num_epochs,
32
                             const uint64_t max_num_samples,
33
                             const int32_t max_seq_length,
34
                             const double short_seq_prob,
35
36
37
38
39
40
41
42
43
44
45
46
47
                             const int32_t seed,
			     const bool verbose) {
    /* Build a mapping of (start-index, end-index, sequence-length) where
       start and end index are the indices of the sentences in the sample
       and sequence-length is the target sequence length.
    */

    // Consistency checks.
    assert(num_epochs > 0);
    assert(max_seq_length > 1);
    assert(short_seq_prob > 0.0);
    assert(short_seq_prob <= 1.0);
    assert(seed > 0);
48
49
50
51

    // Remove bound checks.
    auto docs = docs_.unchecked<1>();
    auto sizes = sizes_.unchecked<1>();
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

    // For efficiency, convert probability to ratio. Note: rand() generates int.
    const auto short_seq_ratio = static_cast<int32_t>(round(1.0 / short_seq_prob));

    if (verbose) {
        const auto sent_start_index = docs[0];
	const auto sent_end_index = docs[docs_.shape(0) - 1];
	const auto num_sentences = sent_end_index - sent_start_index;
	cout << "    using:" << endl << std::flush;
	cout << "     number of documents:            " << docs_.shape(0) - 1 <<
	  endl << std::flush;
	cout << "     sentences range:                [" << sent_start_index <<
	", " << sent_end_index << ")" << endl << std::flush;
	cout << "     total number of sentences:      " << num_sentences <<
	  endl << std::flush;
	cout << "     number of epochs:               " << num_epochs <<
	  endl << std::flush;
	cout << "     maximum number of samples:      " << max_num_samples <<
	  endl << std::flush;
	cout << "     maximum sequence length:        " << max_seq_length <<
	  endl << std::flush;
	cout << "     short sequence probability:     " << short_seq_prob <<
	endl << std::flush;
	cout << "     short sequence ration (1/prob): " << short_seq_ratio <<
	  endl << std::flush;
	cout << "     seed:                           " << seed << endl <<
	  std::flush;
79
    }
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
80

81
82
83
84
85
86
87
    // Mapping and it's length (1D).
    int64_t num_samples = -1;
    DocIdx* maps = NULL;

    // Perform two iterations, in the first iteration get the size
    // and allocate memory and in the second iteration populate the map.
    bool second = false;
88
    for (int32_t iteration=0; iteration<2; ++iteration) {
89
90

        // Set the seed so both iterations produce the same results.
91
        std::mt19937 rand32_gen(seed);
92
93

        // Set the flag on second iteration.
94
        second = (iteration == 1);
95
96

        // Counters:
97
98
        uint64_t empty_docs = 0;
        uint64_t one_sent_docs = 0;
99
100
101
102
103

        // Current map index.
        uint64_t map_index = 0;

        // For each epoch:
104
105
106
        for (int32_t epoch=0; epoch<num_epochs; ++epoch) {
            if (map_index >= max_num_samples) {
	        if (verbose && (!second)) {
107
		  cout << "    reached " << max_num_samples << " samples after "
108
109
		       << epoch << " epochs ..." << endl << std::flush;
		}
110
111
112
                break;
            }
            // For each document:
113
            for (int32_t doc=0; doc<(docs.shape(0) - 1); ++doc) {
114

115
                // Document sentences are in [sent_index_first, sent_index_last)
116
117
118
                const auto sent_index_first = docs[doc];
                const auto sent_index_last = docs[doc + 1];

119
120
                // At the begining of the document previous index is the
		// start index.
121
122
123
124
125
126
127
128
                auto prev_start_index = sent_index_first;

                // Remaining documents.
                auto num_remain_sent = sent_index_last - sent_index_first;

                // Some bookkeeping
                if ((epoch == 0) && (!second)) {
                    if (num_remain_sent == 0) {
129
		        ++empty_docs;
130
131
                    }
                    if (num_remain_sent == 1) {
132
		        ++one_sent_docs;
133
134
135
136
137
138
139
                    }
                }

                // If we have more than two sentences.
                if (num_remain_sent > 1) {

                    // Set values.
140
141
142
143
144
                    auto seq_len = int32_t{0};
                    auto num_sent = int32_t{0};
                    auto target_seq_len = get_target_sample_len(short_seq_ratio,
								max_seq_length,
								rand32_gen);
145
146
147
148
149

                    // Loop through sentences.
                    for (auto sent_index=sent_index_first;
                         sent_index < sent_index_last; ++sent_index) {

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
180
181
182
183
184
185
186
187
188
189
190
191
		        // Add the size and number of sentences.
		        seq_len += sizes[sent_index];
		        ++num_sent;
			--num_remain_sent;

			// If we have reached the target length.
			// and if not only one sentence is left in the document.
			// and if we have at least two sentneces.
			// and if we have reached end of the document.
			if (((seq_len >= target_seq_len) &&
			     (num_remain_sent > 1) &&
			     (num_sent > 1) ) || (num_remain_sent == 0)) {

			    // Check for overflow.
			    if ((3 * map_index + 2) >
				std::numeric_limits<int64_t>::max()) {
			        cout << "number of samples exceeded maximum "
				     << "allowed by type int64: "
				     << std::numeric_limits<int64_t>::max()
				     << endl;
				throw std::overflow_error("Number of samples");
			    }

			    // Populate the map.
			    if (second) {
			        const auto map_index_0 = 3 * map_index;
				maps[map_index_0] = static_cast<DocIdx>(prev_start_index);
				maps[map_index_0 + 1] = static_cast<DocIdx>(sent_index + 1);
				maps[map_index_0 + 2] = static_cast<DocIdx>(target_seq_len);
			    }

			    // Update indices / counters.
			    ++map_index;
			    prev_start_index = sent_index + 1;
			    target_seq_len = get_target_sample_len(short_seq_ratio,
								   max_seq_length,
								   rand32_gen);
			    seq_len = 0;
			    num_sent = 0;
			}

                    } // for (auto sent_index=sent_index_first; ...
192
193
194
195
196
                } // if (num_remain_sent > 1) {
            } // for (int doc=0; doc < num_docs; ++doc) {
        } // for (int epoch=0; epoch < num_epochs; ++epoch) {

        if (!second) {
197
	    if (verbose) {
198
	        cout << "   number of empty documents: " << empty_docs <<
199
		  endl << std::flush;
200
		cout << "   number of documents with one sentence: " <<
201
		  one_sent_docs << endl << std::flush;
202
		cout << "   will create mapping for " << map_index <<
203
204
205
206
		  " samples" << endl << std::flush;
	    }
	    assert(maps == NULL);
	    assert(num_samples < 0);
207
            maps = new DocIdx[3*map_index];
208
            num_samples = static_cast<int64_t>(map_index);
209
210
211
212
213
        }

    } // for (int iteration=0; iteration < 2; ++iteration) {

    // Shuffle.
214
215
216
    // We need a 64 bit random number generator as we might have more
    // than 2 billion samples.
    std::mt19937_64 rand64_gen(seed + 1);
217
    for (auto i=(num_samples - 1); i > 0; --i) {
218
219
220
221
222
223
224
      const auto j = static_cast<int64_t>(rand64_gen() % (i + 1));
      const auto i0 = 3 * i;
      const auto j0 = 3 * j;
      // Swap values.
      swap(maps[i0], maps[j0]);
      swap(maps[i0 + 1], maps[j0 + 1]);
      swap(maps[i0 + 2], maps[j0 + 2]);
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
225
226
    }

227
228
229
    // Method to deallocate memory.
    py::capsule free_when_done(maps, [](void *mem_) {
            DocIdx *mem = reinterpret_cast<DocIdx*>(mem_);
230
	    delete[] mem;
231
        });
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
232

233
    // Return the numpy array.
234
    const auto byte_size = sizeof(DocIdx);
235
    return py::array(std::vector<int64_t>{num_samples, 3}, // shape
236
                     {3*byte_size, byte_size}, // C-style contiguous strides
237
238
                     maps, // the data pointer
                     free_when_done); // numpy array references
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
239

240
}
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
241

242
243
244

py::array build_mapping(const py::array_t<int64_t>& docs_,
                        const py::array_t<int>& sizes_,
245
246
247
248
                        const int num_epochs,
                        const uint64_t max_num_samples,
                        const int max_seq_length,
                        const double short_seq_prob,
249
250
251
                        const int seed,
			const bool verbose) {

252
    if (sizes_.size() > std::numeric_limits<uint32_t>::max()) {
253
        if (verbose) {
254
255
256
	   cout << "    using uint64 for data mapping..." << endl << std::flush;
	}
	return build_mapping_impl<uint64_t>(docs_, sizes_, num_epochs,
257
258
					    max_num_samples, max_seq_length,
					    short_seq_prob, seed, verbose);
259
    } else {
260
261
262
263
264
265
       if (verbose) {
	   cout << "    using uint32 for data mapping..." << endl << std::flush;
       }
       return build_mapping_impl<uint32_t>(docs_, sizes_, num_epochs,
					   max_num_samples, max_seq_length,
					   short_seq_prob, seed, verbose);
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
266
267
268
    }
}

269

Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
270
PYBIND11_MODULE(helpers, m) {
271
    m.def("build_mapping", &build_mapping);
Mohammad Shoeybi's avatar
Mohammad Shoeybi committed
272
}