https://github.com/google-research/unique-randomizer

UniqueRandomizer is a data structure for sampling outputs of a randomized program, such as a neural sequence model, incrementally and without replacement.

https://github.com/google-research/unique-randomizer

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

UniqueRandomizer is a data structure for sampling outputs of a randomized program, such as a neural sequence model, incrementally and without replacement.

Basic Info
  • Host: GitHub
  • Owner: google-research
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 40 KB
Statistics
  • Stars: 10
  • Watchers: 5
  • Forks: 4
  • Open Issues: 0
  • Releases: 0
Archived
Created over 5 years ago · Last pushed over 5 years ago
Metadata Files
Readme Contributing License

README.md

UniqueRandomizer

Overview

UniqueRandomizer is a data structure for sampling outputs of a randomized program, such as a neural sequence model, incrementally and without replacement.

  • Incremental sampling: Instead of sampling a large batch of outputs all at once, as with beam search, UniqueRandomizer provides samples one at a time. This enables flexibility in stopping criteria, such as stopping the sampling process as soon as a satisfactory output is found.
  • Sampling without replacement: In many applications, a neural model is used to produce candidate solutions to some search or optimization problem. In such applications it is usually desirable to consider unique candidate solutions, since duplicates are typically not useful.

For more details, refer to our paper, Incremental Sampling Without Replacement for Sequence Models, published at ICML 2020.

BibTeX entry:

@article{shi2020uniquerandomizer, title = {Incremental Sampling Without Replacement for Sequence Models}, author = {Kensen Shi and David Bieber and Charles Sutton}, booktitle = {Proceedings of the 37th International Conference on Machine Learning}, year = {2020} }

Installation

python3 -m pip install --user unique-randomizer

This package requires Python 3. The above command automatically installs the following dependencies as well:

  • absl-py >= 0.6.1
  • numpy >= 1.15.4
  • scipy >= 1.1.0

Usage

To use UniqueRandomizer, first identify the program or function that you wish to draw unique samples from, such as the draw_sample function in the following example:

def draw_sample(sequence_model, state): """Draws a sample (a sequence of token indices) from the sequence model.""" tokens = [] token = BOS for i in range(MAX_LEN): probs, state = sequence_model(token, state) token = np.random.choice(np.arange(len(probs)), p=probs) if token == EOS: break tokens.append(token) return tokens

Note that draw_sample can take inputs and can use control flow such as loops, conditionals, and recursion. There are only two constraints on the draw_sample function:

  1. It must be deterministic given the inputs, except for random choices provided by np.random.choice (or some other method of selecting a random index given a discrete probability distribution).
  2. Two different sequences of random choices must lead to draw_sample returning different outputs.

Next, add a UniqueRandomizer object as an input to draw_sample, and use its sample_distribution function to replace np.random.choice:

diff - def draw_sample(sequence_model, state): + def draw_sample(sequence_model, state, randomizer): """Draws a sample (a sequence of token indices) from the sequence model.""" tokens = [] token = BOS for i in range(MAX_LEN): probs, state = sequence_model(token, state) - token = np.random.choice(np.arange(len(probs)), p=probs) + token = randomizer.sample_distribution(probs) if token == EOS: break tokens.append(token) return tokens

Finally, a simple loop around draw_sample can collect unique samples, as follows:

def draw_unique_samples(model, state, num_samples): """Draws multiple unique samples from the sequence model.""" samples = [] randomizer = unique_randomizer.UniqueRandomizer() for _ in range(num_samples): samples.append(draw_sample(model, state, randomizer)) randomizer.mark_sequence_complete() return samples

Code Samples

We include a few code samples that demonstrate how to use UniqueRandomizer:

  • examples/weighted_coin_flips.py: This provides a very simple example of using UniqueRandomizer. The function flip_two_weighted_coins simulates flipping a pair of weighted coins. The sample_flips_without_replacement function then uses UniqueRandomizer to efficiently sample outputs of flip_two_weighted_coins without replacement.

  • examples/expand_grammar.py: This defines a Probabilistic Context-Free Grammar (PCFG), as well as methods to sample elements of the grammar without replacement by using UniqueRandomizer, rejection sampling, and Stochastic Beam Search (SBS). The script examples/expand_grammar_main.py enables easy comparison between the different sampling methods under different scenarios.

  • examples/sequence_example.py: This implements sampling without replacement from a sequence model, using UniqueRandomizer, Batched UniqueRandomizer, rejection sampling, and SBS. The script examples/sequence_example_main.py enables easy comparison between the different sampling methods under different scenarios.

Disclaimer

This is not an officially supported Google product.

Owner

  • Name: Google Research
  • Login: google-research
  • Kind: organization
  • Location: Earth

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1
  • Total Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kensen Shi 6****s@u****m 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 10 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
pypi.org: unique-randomizer

UniqueRandomizer: Incremental Sampling Without Replacement

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 10 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 16.9%
Stargazers count: 20.4%
Dependent repos count: 21.6%
Average: 24.1%
Downloads: 51.4%
Maintainers (1)
Last synced: 7 months ago