feat: Enabling automation of experiments running v2.0 #469

xisen-w · 2024-11-04T02:27:32Z

Description

This PR provides the automation of experimentation and result collection.

Motivation and Context

This change is required to streamline the process of running experiments, reducing manual setup and potential errors. It solves the problem of inconsistent experiment configurations and enhances the automation capabilities of the system.

How Has This Been Tested?

Verified that the run_envs.sh and test_system.sh script runs without errors and correctly sets up the environment for experiments.
x ] Tested the script with various setup types to ensure all configurations are applied as expected.

Screenshots of Test Results (if appropriate):

Pipeline test: All tests passed successfully, confirming the script's functionality.
Your own tests: Custom test scripts were executed to validate the automation process, with all tests passing.

Types of changes

Fix bugs
Add new feature

📚 Documentation preview 📚: https://RDAgent--469.org.readthedocs.build/en/469/

…D-Agent into automated-evaluation

you-n-g · 2024-11-20T14:44:02Z

scripts/exp/ablation/env/basic.env

@@ -0,0 +1,5 @@
+if_using_vector_rag=False


the environment should capitalized.

you-n-g · 2024-11-20T14:50:04Z

rdagent/scenarios/kaggle/automated_evaluation/results/20241107_051618/experiment_info.json

@@ -0,0 +1,8 @@
+{


Why do you submit this file?

I thought since this was not to be merged I could show how the json is organised for now.

I will hide it in the next commit.

you-n-g · 2024-11-20T14:50:27Z

rdagent/scenarios/kaggle/automated_evaluation/eval.sh

@@ -0,0 +1,136 @@
+#!/bin/bash
+


What is this file for?

you-n-g · 2024-11-20T14:50:37Z

.gitignore

@@ -117,6 +117,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.huaxia_env


what is this for? is it necessary?

Thanks for the feedback! Was about to hide this.

…D-Agent into automated-evaluation

microsoft-github-policy-service · 2024-11-25T12:36:50Z

@xisen-w please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

you-n-g · 2024-11-25T16:26:17Z

scripts/exp/ablation/README.md

@@ -0,0 +1,9 @@
+# Introduction
+
+| name | .env      | desc |


this file is not complete

you-n-g · 2024-11-25T16:27:27Z

scripts/exp/tools/README.md

+1. Ensure the scripts have execution permissions:
+
+```
+chmod +x scripts/exp/tools/run_envs.sh


You can commit the file permission to github directly instead of writting them in README.md

you-n-g · 2024-11-25T16:30:07Z

scripts/exp/tools/README.md

+1.	Ensure the scripts are executable:
+
+```
+chmod +x scripts/exp/tools/run_envs.sh


same as above

you-n-g · 2024-11-25T16:31:44Z

scripts/exp/tools/README.md

+### Notes
+* Scale parallel processes as needed using the -j parameter.
+* Avoid errors by ensuring .env files are correctly formatted.
+* Modify test_system.sh to meet your project's specific needs.


When should we modifiy the script?

you-n-g · 2024-11-25T16:33:36Z

scripts/exp/tools/collect.py

@@ -0,0 +1,83 @@
+import os


Will the env name (e.g. basic, max, pro) displayed in the collected results?

you-n-g · 2024-11-25T16:35:25Z

scripts/exp/tools/test_system.sh

+mkdir -p "$TEST_DIR/logs"
+
+# Define paths
+ENV_DIR="/home/v-xisenwang/RD-Agent/scripts/exp/ablation/env"


I think it would be better to use config for the path instead of hard-coded

you-n-g · 2024-11-25T16:36:37Z

scripts/exp/tools/README.md

+
+```
+python collect.py --log_path logs --output_name summary.json
+```


I think it would be better to give an example of the collected results.

WinstonLiyt · 2024-11-25T16:43:46Z

scripts/exp/ablation/env/pro.env

Here, it also needs to add the path to the knowledge base.

WinstonLiyt · 2024-11-25T16:44:05Z

scripts/exp/ablation/env/max.env

Here, it needs to add the path to the knowledge base.

WinstonLiyt · 2024-11-25T16:45:15Z

scripts/exp/ablation/env/max.env

KG_IF_USING_VECTOR_RAG here should be set to false.

xisen-w and others added 5 commits November 4, 2024 02:25

Revising to enable automation of experiments running v1.0

8726ab8

Any new updates

b44bef5

Revising to enable automation of experiments running v1.0

c100876

Any new updates

18370d4

Add template

21a99d2

you-n-g force-pushed the automated-evaluation branch from b44bef5 to 21a99d2 Compare November 15, 2024 16:16

xisen-w added 4 commits November 20, 2024 08:23

Stoping tracking additional env

86ae0b2

Merge branch 'automated-evaluation' of https://github.com/microsoft/R…

f94dbff

…D-Agent into automated-evaluation

Uploading relevant envs

66ffd6d

Adding tests

0ef80a5

you-n-g reviewed Nov 20, 2024

View reviewed changes

xisen-w and others added 11 commits November 20, 2024 14:53

Updating

907d980

Updated collect.py to extract result from trace

51388d1

Update .gitignore to remove the unecessary ones

af6220e

"Remove unnecessary files"

54c3c6d

Merge branch 'automated-evaluation' of https://github.com/microsoft/R…

78708e4

…D-Agent into automated-evaluation

Merge branch 'main' into automated-evaluation

3f131f3

Updated to enable automatic collection of experiment result information

38bb9e6

Updating the env files & Upading test_system file

10b0053

Updated relevant env for better testing

238f492

Updated README.md

68ca63a

reverting gitignore back

8b18fad

xisen-w changed the title ~~Enabling automation of experiments running v1.0~~ Enabling automation of experiments running 2.0 Nov 25, 2024

xisen-w changed the title ~~Enabling automation of experiments running 2.0~~ Enabling automation of experiments running v2.0 Nov 25, 2024

xisen-w changed the title ~~Enabling automation of experiments running v2.0~~ feat: Enabling automation of experiments running v2.0 Nov 25, 2024

you-n-g reviewed Nov 25, 2024

View reviewed changes

WinstonLiyt reviewed Nov 25, 2024

View reviewed changes

xisen-w added 2 commits December 3, 2024 03:05

Updates

2395dc5

README update

b7cc98e

xisen-w added 2 commits December 3, 2024 03:15

Updates on env README

0b5a09d

Updating collect.py

24cd0c2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Enabling automation of experiments running v2.0 #469

feat: Enabling automation of experiments running v2.0 #469

xisen-w commented Nov 4, 2024 •

edited

Loading

you-n-g Nov 20, 2024

you-n-g Nov 20, 2024

xisen-w Nov 20, 2024

you-n-g Nov 20, 2024

you-n-g Nov 20, 2024

xisen-w Nov 20, 2024

microsoft-github-policy-service bot commented Nov 25, 2024

Contribution License Agreement

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

you-n-g Nov 25, 2024

WinstonLiyt Nov 25, 2024

WinstonLiyt Nov 25, 2024

WinstonLiyt Nov 25, 2024

feat: Enabling automation of experiments running v2.0 #469

Are you sure you want to change the base?

feat: Enabling automation of experiments running v2.0 #469

Conversation

xisen-w commented Nov 4, 2024 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots of Test Results (if appropriate):

Types of changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

microsoft-github-policy-service bot commented Nov 25, 2024

Contribution License Agreement

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xisen-w commented Nov 4, 2024 •

edited

Loading