diff --git a/Project_report.md b/Evaluation.md similarity index 100% rename from Project_report.md rename to Evaluation.md diff --git a/README.md b/README.md index 5896aec21f1aaee77ada28cf252be64b2dd8f1ac..27bb17e49bb04d917292b143ab91057a89168245 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,46 @@ -# ailogical +# Solving Puzzles with LLMs and Reasoning Models +This project explores the performance of two language models, LLaMa-3.1-8b-instant and LLaMa-3.3-70b-specdec, in solving a collection of riddles. The models are evaluated on their ability to solve a variety of riddles, with a focus on logical deduction, reasoning, and problem-solving strategies. +## Models Tested +- LLaMa-3.1-8b-instant: A general-purpose language model with basic reasoning capabilities. +- LLaMa-3.3-70b-specdec: A reasoning-focused model designed to handle more complex, multi-step problem-solving tasks. -## Getting started +## Riddles Dataset +The dataset consists of 28 riddles from a variety of categories, including: -To make it easy for you to get started with GitLab, here's a list of recommended next steps. +- Logic puzzles -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! +- Mathematical riddles -## Add your files +- Verbal reasoning challenges -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: +## Installation +To run this project, clone the repository and install the required dependencies: +``` python +# Install dependencies +pip install -r requirements.txt ``` -cd existing_repo -git remote add origin https://gitlab.cl.uni-heidelberg.de/monteiro/ailogical.git -git branch -M master -git push -uf origin master -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.cl.uni-heidelberg.de/monteiro/ailogical/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. ## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. +To test the models on a set of riddles, you can run the following script: -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. +``` +python llama.py +``` -## Contributing -State if you are open to contributions and what your requirements are for accepting them. +Make sure to have your models set up before running the script. -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. +## Future Work +- Data Contamination: Measure the memorization and exploitation of patterns within the models' training data. -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. +- Fine-Tuning: Explore how fine-tuning models on logic-based datasets could improve their performance on riddles. -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. +- Chain-of-Thought (CoT): Investigate the use of prompt-engineering techniques such as Chain-of-Thought (CoT) reasoning to help models reason systematically. -## License -For open source projects, say how it is licensed. +## Contribution +Author: Diogo Barbosa Monteiro -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +## Contact +Email: monteiro@cl.uni-heidelberg.de \ No newline at end of file diff --git a/llama.py b/llama.py index e8d9730c0d069b6b915b99b20837d9bcaf779911..1726bc624141eae5d7407bc8e59e05dc0209e03c 100644 --- a/llama.py +++ b/llama.py @@ -3,7 +3,7 @@ from typing import Dict, List from groq import Groq import pandas as pd -# Get a free API key from https://console.groq.com/keys + os.environ["GROQ_API_KEY"] = "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" LLM = "llama-3.1-8b-instant" @@ -11,8 +11,9 @@ REASONING_MODEL = "llama-3.3-70b-specdec" DEFAULT_MODEL = LLM client = Groq() - +# Load the CSV for original riddles df = pd.read_csv('logic_puzzles.csv') +# Load the CSV for modified riddles df = pd.read_csv("modified_puzzles.csv") def assistant(content: str): @@ -48,19 +49,14 @@ def completion( top_p=top_p, ) -def complete_and_print(prompt: str, model: str = DEFAULT_MODEL): - print(f'==============\n{prompt}\n==============') - prompt = f"{prompt}\nTry to keep your answer count to one answer." - response = completion(prompt, model) - print(response, end='\n\n') - def main(): answers = [] for i in range(len(df)): + # Generate answers using the LLM and reasoning model llm_answer = completion(df["puzzle"][i]) reasoning_answer = completion(df["puzzle"][i], model=REASONING_MODEL) answers.append({"puzzle": df["puzzle"][i], "answer": df["answer"][i], "LLM answer": llm_answer, "Reasoning answer": reasoning_answer}) - + # Save the answers to a JSON file with open('trick_answers.json', 'w') as f: json.dump(answers, f, indent=4) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..7e9b11c22aa1b86303f6819a3c6d9297b94c8e39 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +groq==0.20.0 +pandas==2.2.3