First commit

Co-Authored-By: Donghao Ren <1595237+donghaoren@users.noreply.github.com>
Co-Authored-By: Yannick Assogba <26408+tafsiri@users.noreply.github.com>

Author: donghaoren

.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+data/
+logs/

CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the open source team at [opensource-conduct@group.apple.com](mailto:opensource-conduct@group.apple.com). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contribution Guide
+
+Thanks for your interest in contributing. This project was released to accompany a research paper for purposes of reproducibility, and beyond its publication there are limited plans for future development of the repository.
+
+While we welcome new pull requests and issues please note that our response may be limited. Forks and out-of-tree improvements are strongly encouraged.
+
+## Before you get started
+
+By submitting a pull request, you represent that you have the right to license your contribution to Apple and the community, and agree by submitting the patch that your contributions are licensed under the [LICENSE](LICENSE).
+
+We ask that all community members read and observe our [Code of Conduct](CODE_OF_CONDUCT.md).

LICENSE

@@ -0,0 +1,39 @@
+Copyright (C) 2024 Apple Inc. All Rights Reserved.
+
+IMPORTANT:  This Apple software is supplied to you by Apple
+Inc. ("Apple") in consideration of your agreement to the following
+terms, and your use, installation, modification or redistribution of
+this Apple software constitutes acceptance of these terms.  If you do
+not agree with these terms, please do not use, install, modify or
+redistribute this Apple software.
+
+In consideration of your agreement to abide by the following terms, and
+subject to these terms, Apple grants you a personal, non-exclusive
+license, under Apple's copyrights in this original Apple software (the
+"Apple Software"), to use, reproduce, modify and redistribute the Apple
+Software, with or without modifications, in source and/or binary forms;
+provided that if you redistribute the Apple Software in its entirety and
+without modifications, you must retain this notice and the following
+text and disclaimers in all such redistributions of the Apple Software.
+Neither the name, trademarks, service marks or logos of Apple Inc. may
+be used to endorse or promote products derived from the Apple Software
+without specific prior written permission from Apple.  Except as
+expressly stated in this notice, no other rights or licenses, express or
+implied, are granted by Apple herein, including but not limited to any
+patent rights that may be infringed by your derivative works or by other
+works in which the Apple Software may be incorporated.
+
+The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
+MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+
+IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,91 @@
+# Synthetic data generator for multi-step key retrieval tasks
+
+This folder contains code to generate synthetic data for one-step, two-step, three-step, and concatenation tasks.
+
+These tasks are used in the following paper: <https://arxiv.org/abs/2407.21049>.
+
+Install dependencies with:
+
+```bash
+pip install click datasets transformers
+```
+
+or if you want to use the dependency versions specified in requirements.txt do:
+
+```bash
+pip install -r requirements.txt
+```
+
+To generate the dataset for the main experiment from the paper, run:
+
+```bash
+python generate_data.py krc
+```
+
+To generate the dataset for the experiment on improving performance with call graph comments, run:
+
+```bash
+python generate_data.py krfix
+python generate_data.py krfix_one_hop
+```
+
+The generated dataset will be saved to the `data` folder.
+
+The dataset will contain a set of gzip-compressed JSON. Each JSON is an array of prompts and associated metadata. Below is an example:
+
+```js
+{
+  // The prompt
+  "prompt": "<the prompt string>",
+  // A prefix regex to constraint decoding
+  "force_decode_regex": "^[ \t]*(['\"]|$)",
+  "metadata": {
+    // The name of the model used to tokenize the prompt
+    "model_name": "bigcode/starcoderbase",
+
+    // The expected output string (as a python string literal)
+    "expected": " \"eooyfwmxln\"",
+    // Total number of tokens in the prompt, with the current model's tokenizer
+    "prompt_token_count": 7929,
+    // The permutation of the task-relevant snippets
+    "permutation": [0, 1],
+    // The positions of the task-relevant snippets among all snippets
+    "positions": [2, 10],
+    // The string ranges of each task-relevant snippet, always in the original order (before any permutation).
+    // The snippet can be retrieved with prompt[range[0]:range[1]]
+    "string_ranges": [
+      [1295, 1339],
+      [6032, 6079]
+    ],
+    // The token ranges of each task-relevant snippet, always in the original order (before any permutation)
+    "token_ranges": [
+      [351, 373],
+      [1834, 1860]
+    ],
+    // The task
+    "variant": "two-step",
+    // The number of distractor functions
+    "num_distractors": 1,
+    // The max number of tokens in the prompt
+    "max_prompt_tokens": 8000,
+
+    // The max number of snippets from HumanEval (a very large number effectively removes the limit)
+    "max_humaneval_snippets": 1000000,
+    // The string length range of HumanEval snippets to include
+    "humaneval_min_length": 250,
+    "humaneval_max_length": 1000,
+
+    // For krfix, the call graph comment type and template
+    "call_graph_comment_type": "calls,called_by",
+    "call_graph_template_variant": "calls_called_by"
+
+    // Configuration of the task snippets (fixed for the experiment)
+    "return_type": "string",
+    "return_length": 10,
+    "function_name": "random",
+    "function_name_part_length": 6,
+    "function_name_min_parts": 2,
+    "function_name_max_parts": 3,
+  }
+}
+```