Skip to content

Commit d9a4c66

Browse files
committed
update readme
1 parent 2f3c3dc commit d9a4c66

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Each subdirectory is scoped to run only one AI/ML integration's suite of tests f
2222
Within each subdirectory you should expect to have:
2323

2424
- `run.sh` -- A script that should handle any additional library installations and steps for executing the test suite. This script should not populate the Atlas database with any required test data.
25+
- `config.env` - A file that defines the following environment variables:
26+
- `REPO_NAME` -- The name of the AI/ML framework repository that will get cloned
27+
- `CLONE_URL` -- The Github URL to clone into the specified `DIR`
28+
- `DATABASE` -- The optional database where the Atlas CLI will load your index configs
2529
- `database/` -- An optional directory used by `.evergreen/scaffold_atlas.py` to populate a MongoDB database with test data. Only provide this if your tests require pre-populated data.
2630
- `database/{collection}.json` -- An optional JSON file containing one or more MongoDB documents that will be uploaded to `$DATABASE.{collection}` in the local Atlas instance. Only provide this if your tests require pre-populated data.
2731
- `indexConfig.json` -- An optional file containing configuration for a specified Atlas Search Index.
@@ -40,12 +44,15 @@ The general layout of this repo looks like this:
4044
│ │ └── furthestSearch.json # Populates $DATABASE.furthestSearch
4145
│ ├── indexes # Optional Index definitions directory
4246
│ │ └── indexConfig.json # Optional Search index definition
47+
| ├── config.env # Configuration file
4348
│ └── run.sh # Script that executes test
49+
|
4450
├── semantic-kernel-python # Folder scoped for one Integration
4551
│ ├── database # Optional database definition
4652
│ │ └── nearestSearch.json # Populates $DATABASE.nearestSearch
4753
│ │ └── furthestSearch.json # Populates $DATABASE.furthestSearch
4854
│ ├── indexConfig.json # Creates Search Index on $DATABASE
55+
| ├── config.env # Configuration file
4956
│ └── run.sh # Script that executes test
5057
```
5158

@@ -97,9 +104,6 @@ Test execution flow is defined in `.evergreen/config.yml`. The test pipeline's c
97104
- [`expansions`](https://docs.devprod.prod.corp.mongodb.com/evergreen/Project-Configuration/Project-Configuration-Files/#expansions) -- Build variant specific variables. Expansions that need to be maintained as secrets should be stored in [the Evergreen project settings](https://spruce.mongodb.com/project/ai-ml-pipeline-testing/settings/variables) using [variables](https://docs.devprod.prod.corp.mongodb.com/evergreen/Project-Configuration/Project-and-Distro-Settings#variables). Some common expansions needed are:
98105

99106
- `DIR` -- The subdirectory where the tasks will run
100-
- `REPO_NAME` -- The name of the AI/ML framework repository that will get cloned
101-
- `CLONE_URL` -- The Github URL to clone into the specified `DIR`
102-
- `DATABASE` -- The optional database where the Atlas CLI will load your index configs
103107

104108
- `run_on` -- Specified platform to run on. `rhel87-small` should be used by default. Any other distro may fail Atlas CLI setup.
105109
- `tasks` -- Tasks to run. See below for more details

0 commit comments

Comments
 (0)