|
1 | | -# Python Evaluation Function |
| 1 | +# evaluatePython Evaluation Function |
2 | 2 |
|
3 | | -This repository contains the boilerplate code needed to create a containerized evaluation function written in Python. |
| 3 | +This repository uses an existing autograder to provide formative feedback on Python code. |
4 | 4 |
|
5 | 5 | ## Deployment |
6 | | -[](https://github.com/lambda-feedback/{REPO_NAME_HERE}/issues/new?template=release-request.yml) |
| 6 | +[](https://github.com/lambda-feedback/evaluatePython/issues/new?template=release-request.yml) |
7 | 7 | To deploy to production, update the README button above to point to the correct repository. |
8 | 8 |
|
9 | | -## Quickstart |
10 | | - |
11 | | -This chapter helps you to quickly set up a new Python evaluation function using this template repository. |
12 | | - |
13 | | -> [!NOTE] |
14 | | -> After setting up the evaluation function, delete this chapter from the `README.md` file, and add your own documentation. |
15 | | -
|
16 | | -#### 1. Create a new repository |
17 | | - |
18 | | -- In GitHub, choose `Use this template` > `Create a new repository` in the repository toolbar. |
19 | | - |
20 | | -- Choose the owner, and pick a name for the new repository. |
21 | | - |
22 | | - > [!IMPORTANT] |
23 | | - > If you want to deploy the evaluation function to Lambda Feedback, make sure to choose the Lambda Feedback organization as the owner. |
24 | | -
|
25 | | -- Set the visibility to `Public` or `Private`. |
26 | | - |
27 | | - > [!IMPORTANT] |
28 | | - > If you want to use GitHub [deployment protection rules](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules), make sure to set the visibility to `Public`. |
29 | | -
|
30 | | -- Click on `Create repository`. |
31 | | - |
32 | | -#### 2. Clone the new repository |
33 | | - |
34 | | -Clone the new repository to your local machine using the following command: |
35 | | - |
36 | | -```bash |
37 | | -git clone <repository-url> |
38 | | -``` |
39 | | - |
40 | | -#### 3. Configure the evaluation function |
41 | | - |
42 | | -When deploying to Lambda Feedback, set the evaluation function name in the `config.json` file. Read the [Deploy to Lambda Feedback](#deploy-to-lambda-feedback) section for more information. |
43 | | - |
44 | | -#### 4. Develop the evaluation function |
45 | | - |
46 | | -You're ready to start developing your evaluation function. Head over to the [Development](#development) section to learn more. |
47 | | - |
48 | | -#### 5. Update the README |
49 | | - |
50 | | -In the `README.md` file, change the title and description so it fits the purpose of your evaluation function. |
51 | | - |
52 | | -Also, don't forget to delete the Quickstart chapter from the `README.md` file after you've completed these steps. |
53 | 9 |
|
54 | 10 | ## Usage |
55 | 11 |
|
|
0 commit comments