#include "lm/builder/pipeline.hh" #include "lm/builder/adjust_counts.hh" #include "lm/builder/corpus_count.hh" #include "lm/builder/hash_gamma.hh" #include "lm/builder/initial_probabilities.hh" #include "lm/builder/interpolate.hh" #include "lm/builder/output.hh" #include "lm/builder/sort.hh" #include "lm/sizes.hh" #include "util/exception.hh" #include "util/file.hh" #include "util/stream/io.hh" #include #include #include #include namespace lm { namespace builder { namespace { void PrintStatistics(const std::vector &counts, const std::vector &counts_pruned, const std::vector &discounts) { std::cerr << "Statistics:\n"; for (size_t i = 0; i < counts.size(); ++i) { std::cerr << (i + 1) << ' ' << counts_pruned[i]; if(counts[i] != counts_pruned[i]) std::cerr << "/" << counts[i]; for (size_t d = 1; d <= 3; ++d) std::cerr << " D" << d << (d == 3 ? "+=" : "=") << discounts[i].amount[d]; std::cerr << '\n'; } } class Master { public: explicit Master(PipelineConfig &config) : config_(config), chains_(config.order), files_(config.order) { config_.minimum_block = std::max(NGram::TotalSize(config_.order), config_.minimum_block); } const PipelineConfig &Config() const { return config_; } util::stream::Chains &MutableChains() { return chains_; } template Master &operator>>(const T &worker) { chains_ >> worker; return *this; } // This takes the (partially) sorted ngrams and sets up for adjusted counts. void InitForAdjust(util::stream::Sort &ngrams, WordIndex types) { const std::size_t each_order_min = config_.minimum_block * config_.block_count; // We know how many unigrams there are. Don't allocate more than needed to them. const std::size_t min_chains = (config_.order - 1) * each_order_min + std::min(types * NGram::TotalSize(1), each_order_min); // Do merge sort with calculated laziness. const std::size_t merge_using = ngrams.Merge(std::min(config_.TotalMemory() - min_chains, ngrams.DefaultLazy())); std::vector count_bounds(1, types); CreateChains(config_.TotalMemory() - merge_using, count_bounds); ngrams.Output(chains_.back(), merge_using); // Setup unigram file. files_.push_back(util::MakeTemp(config_.TempPrefix())); } // For initial probabilities, but this is generic. void SortAndReadTwice(const std::vector &counts, Sorts &sorts, util::stream::Chains &second, util::stream::ChainConfig second_config) { // Do merge first before allocating chain memory. for (std::size_t i = 1; i < config_.order; ++i) { sorts[i - 1].Merge(0); } // There's no lazy merge, so just divide memory amongst the chains. CreateChains(config_.TotalMemory(), counts); chains_.back().ActivateProgress(); chains_[0] >> files_[0].Source(); second_config.entry_size = NGram::TotalSize(1); second.push_back(second_config); second.back() >> files_[0].Source(); for (std::size_t i = 1; i < config_.order; ++i) { util::scoped_fd fd(sorts[i - 1].StealCompleted()); chains_[i].SetProgressTarget(util::SizeOrThrow(fd.get())); chains_[i] >> util::stream::PRead(util::DupOrThrow(fd.get()), true); second_config.entry_size = NGram::TotalSize(i + 1); second.push_back(second_config); second.back() >> util::stream::PRead(fd.release(), true); } } // There is no sort after this, so go for broke on lazy merging. template void MaximumLazyInput(const std::vector &counts, Sorts &sorts) { // Determine the minimum we can use for all the chains. std::size_t min_chains = 0; for (std::size_t i = 0; i < config_.order; ++i) { min_chains += std::min(counts[i] * NGram::TotalSize(i + 1), static_cast(config_.minimum_block)); } std::size_t for_merge = min_chains > config_.TotalMemory() ? 0 : (config_.TotalMemory() - min_chains); std::vector laziness; // Prioritize longer n-grams. for (util::stream::Sort *i = sorts.end() - 1; i >= sorts.begin(); --i) { laziness.push_back(i->Merge(for_merge)); assert(for_merge >= laziness.back()); for_merge -= laziness.back(); } std::reverse(laziness.begin(), laziness.end()); CreateChains(for_merge + min_chains, counts); chains_.back().ActivateProgress(); chains_[0] >> files_[0].Source(); for (std::size_t i = 1; i < config_.order; ++i) { sorts[i - 1].Output(chains_[i], laziness[i - 1]); } } void BufferFinal(const std::vector &counts) { chains_[0] >> files_[0].Sink(); for (std::size_t i = 1; i < config_.order; ++i) { files_.push_back(util::MakeTemp(config_.TempPrefix())); chains_[i] >> files_[i].Sink(); } chains_.Wait(true); // Use less memory. Because we can. CreateChains(std::min(config_.sort.buffer_size * config_.order, config_.TotalMemory()), counts); for (std::size_t i = 0; i < config_.order; ++i) { chains_[i] >> files_[i].Source(); } } template void SetupSorts(Sorts &sorts) { sorts.Init(config_.order - 1); // Unigrams don't get sorted because their order is always the same. chains_[0] >> files_[0].Sink(); for (std::size_t i = 1; i < config_.order; ++i) { sorts.push_back(chains_[i], config_.sort, Compare(i + 1)); } chains_.Wait(true); } private: // Create chains, allocating memory to them. Totally heuristic. Count // bounds are upper bounds on the counts or not present. void CreateChains(std::size_t remaining_mem, const std::vector &count_bounds) { std::vector assignments; assignments.reserve(config_.order); // Start by assigning maximum memory usage (to be refined later). for (std::size_t i = 0; i < count_bounds.size(); ++i) { assignments.push_back(static_cast(std::min( static_cast(remaining_mem), count_bounds[i] * static_cast(NGram::TotalSize(i + 1))))); } assignments.resize(config_.order, remaining_mem); // Now we know how much memory everybody wants. How much will they get? // Proportional to this. std::vector portions; // Indices of orders that have yet to be assigned. std::vector unassigned; for (std::size_t i = 0; i < config_.order; ++i) { portions.push_back(static_cast((i+1) * NGram::TotalSize(i+1))); unassigned.push_back(i); } /*If somebody doesn't eat their full dinner, give it to the rest of the * family. Then somebody else might not eat their full dinner etc. Ends * when everybody unassigned is hungry. */ float sum; bool found_more; std::vector block_count(config_.order); do { sum = 0.0; for (std::size_t i = 0; i < unassigned.size(); ++i) { sum += portions[unassigned[i]]; } found_more = false; // If the proportional assignment is more than needed, give it just what it needs. for (std::vector::iterator i = unassigned.begin(); i != unassigned.end();) { if (assignments[*i] <= remaining_mem * (portions[*i] / sum)) { remaining_mem -= assignments[*i]; block_count[*i] = 1; i = unassigned.erase(i); found_more = true; } else { ++i; } } } while (found_more); for (std::vector::iterator i = unassigned.begin(); i != unassigned.end(); ++i) { assignments[*i] = remaining_mem * (portions[*i] / sum); block_count[*i] = config_.block_count; } chains_.clear(); std::cerr << "Chain sizes:"; for (std::size_t i = 0; i < config_.order; ++i) { std::cerr << ' ' << (i+1) << ":" << assignments[i]; chains_.push_back(util::stream::ChainConfig(NGram::TotalSize(i + 1), block_count[i], assignments[i])); } std::cerr << std::endl; } PipelineConfig &config_; util::stream::Chains chains_; // Often only unigrams, but sometimes all orders. util::FixedArray files_; }; void CountText(int text_file /* input */, int vocab_file /* output */, Master &master, uint64_t &token_count, std::string &text_file_name, std::vector &prune_words) { const PipelineConfig &config = master.Config(); std::cerr << "=== 1/5 Counting and sorting n-grams ===" << std::endl; const std::size_t vocab_usage = CorpusCount::VocabUsage(config.vocab_estimate); UTIL_THROW_IF(config.TotalMemory() < vocab_usage, util::Exception, "Vocab hash size estimate " << vocab_usage << " exceeds total memory " << config.TotalMemory()); std::size_t memory_for_chain = // This much memory to work with after vocab hash table. static_cast(config.TotalMemory() - vocab_usage) / // Solve for block size including the dedupe multiplier for one block. (static_cast(config.block_count) + CorpusCount::DedupeMultiplier(config.order)) * // Chain likes memory expressed in terms of total memory. static_cast(config.block_count); util::stream::Chain chain(util::stream::ChainConfig(NGram::TotalSize(config.order), config.block_count, memory_for_chain)); WordIndex type_count = config.vocab_estimate; util::FilePiece text(text_file, NULL, &std::cerr); text_file_name = text.FileName(); CorpusCount counter(text, vocab_file, token_count, type_count, prune_words, config.prune_vocab_file, chain.BlockSize() / chain.EntrySize(), config.disallowed_symbol_action); chain >> boost::ref(counter); util::stream::Sort sorter(chain, config.sort, SuffixOrder(config.order), AddCombiner()); chain.Wait(true); std::cerr << "Unigram tokens " << token_count << " types " << type_count << std::endl; std::cerr << "=== 2/5 Calculating and sorting adjusted counts ===" << std::endl; master.InitForAdjust(sorter, type_count); } void InitialProbabilities(const std::vector &counts, const std::vector &counts_pruned, const std::vector &discounts, Master &master, Sorts &primary, util::FixedArray &gammas, const std::vector &prune_thresholds, bool prune_vocab) { const PipelineConfig &config = master.Config(); util::stream::Chains second(config.order); { Sorts sorts; master.SetupSorts(sorts); PrintStatistics(counts, counts_pruned, discounts); lm::ngram::ShowSizes(counts_pruned); std::cerr << "=== 3/5 Calculating and sorting initial probabilities ===" << std::endl; master.SortAndReadTwice(counts_pruned, sorts, second, config.initial_probs.adder_in); } util::stream::Chains gamma_chains(config.order); InitialProbabilities(config.initial_probs, discounts, master.MutableChains(), second, gamma_chains, prune_thresholds, prune_vocab); // Don't care about gamma for 0. gamma_chains[0] >> util::stream::kRecycle; gammas.Init(config.order - 1); for (std::size_t i = 1; i < config.order; ++i) { gammas.push_back(util::MakeTemp(config.TempPrefix())); gamma_chains[i] >> gammas[i - 1].Sink(); } // Has to be done here due to gamma_chains scope. master.SetupSorts(primary); } void InterpolateProbabilities(const std::vector &counts, Master &master, Sorts &primary, util::FixedArray &gammas) { std::cerr << "=== 4/5 Calculating and writing order-interpolated probabilities ===" << std::endl; const PipelineConfig &config = master.Config(); master.MaximumLazyInput(counts, primary); util::stream::Chains gamma_chains(config.order - 1); for (std::size_t i = 0; i < config.order - 1; ++i) { util::stream::ChainConfig read_backoffs(config.read_backoffs); if(config.prune_vocab || config.prune_thresholds[i + 1] > 0) read_backoffs.entry_size = sizeof(HashGamma); else read_backoffs.entry_size = sizeof(float); gamma_chains.push_back(read_backoffs); gamma_chains.back() >> gammas[i].Source(); } master >> Interpolate(std::max(master.Config().vocab_size_for_unk, counts[0] - 1 /* is not included */), util::stream::ChainPositions(gamma_chains), config.prune_thresholds, config.prune_vocab, config.output_q); gamma_chains >> util::stream::kRecycle; master.BufferFinal(counts); } } // namespace void Pipeline(PipelineConfig &config, int text_file, Output &output) { // Some fail-fast sanity checks. if (config.sort.buffer_size * 4 > config.TotalMemory()) { config.sort.buffer_size = config.TotalMemory() / 4; std::cerr << "Warning: changing sort block size to " << config.sort.buffer_size << " bytes due to low total memory." << std::endl; } if (config.minimum_block < NGram::TotalSize(config.order)) { config.minimum_block = NGram::TotalSize(config.order); std::cerr << "Warning: raising minimum block to " << config.minimum_block << " to fit an ngram in every block." << std::endl; } UTIL_THROW_IF(config.sort.buffer_size < config.minimum_block, util::Exception, "Sort block size " << config.sort.buffer_size << " is below the minimum block size " << config.minimum_block << "."); UTIL_THROW_IF(config.TotalMemory() < config.minimum_block * config.order * config.block_count, util::Exception, "Not enough memory to fit " << (config.order * config.block_count) << " blocks with minimum size " << config.minimum_block << ". Increase memory to " << (config.minimum_block * config.order * config.block_count) << " bytes or decrease the minimum block size."); UTIL_TIMER("(%w s) Total wall time elapsed\n"); Master master(config); // master's destructor will wait for chains. But they might be deadlocked if // this thread dies because e.g. it ran out of memory. try { util::scoped_fd vocab_file(config.vocab_file.empty() ? util::MakeTemp(config.TempPrefix()) : util::CreateOrThrow(config.vocab_file.c_str())); output.SetVocabFD(vocab_file.get()); uint64_t token_count; std::string text_file_name; std::vector prune_words; CountText(text_file, vocab_file.get(), master, token_count, text_file_name, prune_words); std::vector counts; std::vector counts_pruned; std::vector discounts; master >> AdjustCounts(config.prune_thresholds, counts, counts_pruned, prune_words, config.discount, discounts); { util::FixedArray gammas; Sorts primary; InitialProbabilities(counts, counts_pruned, discounts, master, primary, gammas, config.prune_thresholds, config.prune_vocab); InterpolateProbabilities(counts_pruned, master, primary, gammas); } std::cerr << "=== 5/5 Writing ARPA model ===" << std::endl; output.SetHeader(HeaderInfo(text_file_name, token_count, counts_pruned)); output.Apply(PROB_SEQUENTIAL_HOOK, master.MutableChains()); master >> util::stream::kRecycle; master.MutableChains().Wait(true); } catch (const util::Exception &e) { std::cerr << e.what() << std::endl; abort(); } } }} // namespaces