You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,21 +3,20 @@
3
3
## 1. Being a Codabench user.
4
4
5
5
- Create a user account on https://codalab.lisn.fr and on https://codabench.org.
6
-
- Register on https://codabench.org to this existing competition (IRIS-tuto) https://www.codabench.org/competitions/1115/ and make a submission (from https://github.com/codalab/competition-examples/tree/master/codabench/iris): sample_result_submission and sample_code_submission. See https://github.com/codalab/codabench/wiki/User_Participating-in-a-Competition
7
-
- Create your own private competition (from https://github.com/codalab/competition-examples/tree/master/codabench/ ). See https://github.com/codalab/codabench/wiki/Getting-started-with-Codabench
6
+
- Register on https://codabench.org to this existing competition (IRIS-tuto) https://www.codabench.org/competitions/1115/ and make a submission (from https://github.com/codalab/competition-examples/tree/master/codabench/iris): sample_result_submission and sample_code_submission. See https://docs.codabench.org/latest/Participants/User_Participating-in-a-Competition/
7
+
- Create your own private competition (from https://github.com/codalab/competition-examples/tree/master/codabench/ ). See https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Getting-started-with-Codabench/
8
8
9
9
## 2. Setting a local instance of Codabench.
10
10
11
-
- Follow the tutorial in codabench wiki: https://github.com/codalab/codabench/wiki/Codabench-Installation. According to your hosting OS, you might have to tune your environment file a bit. Try without enabling the SSL protocol (doing so, you don't need a domain name for the server). Try using the embedded Minio storage solution instead of a private cloud storage.
12
-
- If needed, you can also look into https://github.com/codalab/codabench/wiki/How-to-deploy-Codabench-on-your-server
11
+
- Follow the tutorial in codabench docs: https://docs.codabench.org/latest/Developers_and_Administrators/Codabench-Installation/. According to your hosting OS, you might have to tune your environment file a bit. Try without enabling the SSL protocol (doing so, you don't need a domain name for the server). Try using the embedded Minio storage solution instead of a private cloud storage.
12
+
- If needed, you can also look into https://docs.codabench.org/latest/Developers_and_Administrators/How-to-deploy-Codabench-on-your-server/
13
13
14
14
## 3. Using one's local instance
15
15
16
16
- Create your own competition and play with it. You can look at the output logs of each different docker container.
17
-
- Setting you as an admin of your platform (https://github.com/codalab/codabench/wiki/Administrator-procedures#give-superuser-privileges-to-an-user) and visit the Django Admin menu: https://github.com/codalab/codabench/wiki/Administrator-procedures#give-superuser-privileges-to-an-user
18
-
17
+
- Setting you as an admin of your platform (https://docs.codabench.org/latest/Developers_and_Administrators/Administrator-procedures/#give-superuser-privileges-to-a-user) and visit the Django Admin menu: https://docs.codabench.org/latest/Developers_and_Administrators/Administrator-procedures/#give-superuser-privileges-to-a-user
19
18
## 4. Setting an autonomous computer-worker on your PC
20
19
21
-
- Configure and launch the docker container: https://github.com/codalab/codabench/wiki/Compute-Worker-Management---Setup
22
-
- Create a private queue on your new own competition on the production server codabench.org: https://github.com/codalab/codabench/wiki/Queue-Management#create-queue
20
+
- Configure and launch the docker container: https://docs.codabench.org/latest/Organizers/Running_a_benchmark/Compute-Worker-Management---Setup/
21
+
- Create a private queue on your new own competition on the production server codabench.org: https://docs.codabench.org/latest/Organizers/Running_a_benchmark/Queue-Management/#create-queue
23
22
- Assign your own compute-worker to this private queue instead of the default queue.
@@ -30,7 +30,7 @@ You can now login as username "admin" with password "admin" at http://localhost/
30
30
31
31
If you ever need to reset the database, use the script `./reset_db.sh`
32
32
33
-
For more information about installation, checkout [Codabench Basic Installation Guide](https://github.com/codalab/codabench/wiki/Codabench-Installation) and [How to Deploy Server](https://github.com/codalab/codabench/wiki/How-to-deploy-Codabench-on-your-server).
33
+
For more information about installation, checkout [Codabench Basic Installation Guide](https://docs.codabench.org/latest/Developers_and_Administrators/Codabench-Installation/) and [How to Deploy Server](https://docs.codabench.org/latest/Developers_and_Administrators/How-to-deploy-Codabench-on-your-server/).
Copy file name to clipboardExpand all lines: docs/example_scripts/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,4 +4,4 @@ These scripts have been built solely to improve users' understanding of the API
4
4
and expressly not as utility scripts. They can serve as starting places, but they
5
5
ought not be solely relied upon for automation.
6
6
7
-
They exist here for easy testing of robot submissions outlined [here](https://github.com/codalab/competitions-v2/wiki/Robot-submissions).
7
+
They exist here for easy testing of robot submissions outlined [here](https://docs.codabench.org/latest/Developers_and_Administrators/Robot-submissions/).
Copy file name to clipboardExpand all lines: documentation/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@ Welcome to the Codabench Documentation.
3
3
4
4
You can access the documentation generated from this folder [here](https://codalab.org/codabench/latest/)
5
5
6
-
If you want to contribute to the wiki, you can create a Pull Request modifying the files you want (located in `docs/`) while adding a quick explanation on what you have changed and why.
6
+
If you want to contribute to the docs, you can create a Pull Request modifying the files you want (located in `docs/`) while adding a quick explanation on what you have changed and why.
7
7
8
8
9
-
When creating a Pull Request to modify the core code of Codabench, you can also include the wiki modification by modifying the relevant files. Once the Pull Request is merged, the wiki will automatically be updated with your changes (`dev` tag when it's merged into develop, and the `latest` version of the wiki once it's merged in master)
9
+
When creating a Pull Request to modify the core code of Codabench, you can also include the docs modification by modifying the relevant files. Once the Pull Request is merged, the docs will automatically be updated with your changes (`dev` tag when it's merged into develop, and the `latest` version of the docs once it's merged in master)
10
10
11
11
## How to build
12
-
To build the wiki locally, you will have to first install [uv](https://github.com/astral-sh/uv)
12
+
To build the docs locally, you will have to first install [uv](https://github.com/astral-sh/uv)
13
13
14
14
Once that is done, you can run the following commands (while inside this folder):
15
15
@@ -18,12 +18,12 @@ uv sync # You only need to run this once, it will download all the necessary pyt
18
18
PDF=1 uv run mkdocs serve -a localhost:8888 # This will build the site and serve it on localhost:8888
19
19
```
20
20
21
-
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the wiki. Every changes you make will rebuild the documentation.
21
+
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the docs. Every changes you make will rebuild the documentation.
22
22
You can remove the `PDF=1` environement variable if you want to speed up the build process, but you will not generate the related PDF.
23
23
24
24
25
25
### Versioning
26
-
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the wiki.
26
+
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the docs.
27
27
28
28
To use it, you can run the following command:
29
29
```bash
@@ -36,4 +36,4 @@ Check the official Github page of the plugin for more information on how it work
36
36
Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.
37
37
38
38
## Github workflow
39
-
We have Github workflows set up to automatically rebuild the wiki when the `develop` branch receives changes, and when a new tag is created for the `master` branch.
39
+
We have Github workflows set up to automatically rebuild the docs when the `develop` branch receives changes, and when a new tag is created for the `master` branch.
Copy file name to clipboardExpand all lines: documentation/docs/Contribute/contributing.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
## Setting up a local instance of Codabench
8
8
9
-
- Follow the tutorial in codabench [wiki](../Developers_and_Administrators/Codabench-Installation.md). According to your hosting OS, you might have to tune your environment file a bit. Try without enabling the SSL protocol (doing so, you don't need a domain name for the server). Try using the embedded Minio storage solution instead of a private cloud storage.
9
+
- Follow the tutorial in codabench [Docs](../Developers_and_Administrators/Codabench-Installation.md). According to your hosting OS, you might have to tune your environment file a bit. Try without enabling the SSL protocol (doing so, you don't need a domain name for the server). Try using the embedded Minio storage solution instead of a private cloud storage.
10
10
- If needed, you can also look into [How to deploy Codabench on your server](../Developers_and_Administrators/How-to-deploy-Codabench-on-your-server.md)
Copy file name to clipboardExpand all lines: documentation/docs/Newsletters_Archive/CodaLab-in-2024.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Contributors community is very active with **143 pull requests** this year. Sinc
19
19
## Introducing Codabench
20
20
[Codabench](https://codabench.org/), the modernized version of [CodaLab](https://codalab.lisn.fr/), was released in summer 2023, and [presented at JCAD days](https://www.canal-u.tv/chaines/jcad/codalab-competitions-and-codabench-open-source-platforms-to-organize-scientific) in November 2024! Codabench platform software is now concentrating all development effort of the community. In addition to CodaLab features, it offers improved performance, live logs, more transparency, data-centric benchmarks and more!
21
21
22
-
We warmly encourage you to use [codabench.org](https://codabench.org/) for all your new competitions and benchmarks. Note that CodaLab bundles are compatible with Codabench, easing the transition, as explained in the following Wiki page: [How to transition from CodaLab to Codabench](../Organizers/Benchmark_Creation/How-to-transition-from-CodaLab-to-Codabench.md)
22
+
We warmly encourage you to use [codabench.org](https://codabench.org/) for all your new competitions and benchmarks. Note that CodaLab bundles are compatible with Codabench, easing the transition, as explained in the following docs page: [How to transition from CodaLab to Codabench](../Organizers/Benchmark_Creation/How-to-transition-from-CodaLab-to-Codabench.md)
23
23
24
24
CodaLab and Codabench are hosted on servers located at [Paris-Saclay university](https://www.universite-paris-saclay.fr/), maintained by [LISN lab](http://lisn.upsaclay.fr/).
Copy file name to clipboardExpand all lines: documentation/docs/Organizers/Benchmark_Creation/Competition-Bundle-Structure.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,8 +75,8 @@ leaderboard:
75
75
76
76
77
77
## Competition YAML
78
-
The `competition.yaml` file is the most important file in the bundle. It's what Codabench looks for to figure out the structure and layout of your competition, along with additional details. For more information on setting up a `competition.yaml` see the wiki page here:
The `competition.yaml` file is the most important file in the bundle. It's what Codabench looks for to figure out the structure and layout of your competition, along with additional details. For more information on setting up a `competition.yaml` see the docs page here:
This page is relatively simple. It's where you submit a completed competition bundle to Codabench, in order for it to be processed into a competition instance. For more information on competition bundles, see this link here: [Competition Bundle Structure](https://github.com/codalab/competitions-v2/wiki/Competition-Bundle-Structure).
1
+
This page is relatively simple. It's where you submit a completed competition bundle to Codabench, in order for it to be processed into a competition instance. For more information on competition bundles, see this link here: [Competition Bundle Structure](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Bundle-Structure/).
@@ -8,4 +8,4 @@ To begin, just click the paper clip icon, or the bar next to it. It should open
8
8
9
9
## Backward compatibility
10
10
11
-
If you previously used [CodaLab Competitions](https://github.com/codalab/codalab-competitions), note that Codabench is compatible with CodaLab bundles.
11
+
If you previously used [CodaLab Competitions](https://github.com/codalab/codalab-competitions), note that Codabench is compatible with CodaLab bundles.
Copy file name to clipboardExpand all lines: documentation/docs/Organizers/Benchmark_Creation/Dataset-competition-creation-and-participate-instruction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ This page focuses on how to create a dataset contest via bundle and make submiss
5
5
The brief process can be summarized in the following diagram
6
6
7
7
There are two main parts:
8
-
- the contest organizer creates the dataset competition by uploading a bundle (For more information on how to create a contest via bundle, and the definition of bundle, you can refer to this link [Competition-Creation:-Bundle](https://github.com/codalab/competitions-v2/wiki/Competition-Creation:-Bundle))
8
+
- the contest organizer creates the dataset competition by uploading a bundle (For more information on how to create a contest via bundle, and the definition of bundle, you can refer to this link [Competition-Creation:-Bundle](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Creation%3A-Bundle/))
0 commit comments