PapersWithCode Client Class¶
-
class
paperswithcode.client.
PapersWithCodeClient
(token=None, url=None)[source]¶ PapersWithCode client.
-
__init__
(token=None, url=None)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
paper_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers[source]¶ Return a paginated list of papers.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Papers object.
- Return type
-
paper_get
(paper_id: str) → paperswithcode.models.paper.Paper[source]¶ Return a paper by it’s ID.
- Parameters
paper_id (str) – ID of the paper.
- Returns
Paper object.
- Return type
-
paper_repository_list
(paper_id: str) → List[paperswithcode.models.repository.Repository][source]¶ Return a list of paper implementations.
- Parameters
paper_id (str) – ID of the paper.
- Returns
List of repository objects.
- Return type
List[Repository]
-
paper_task_list
(paper_id: str) → List[paperswithcode.models.task.Task][source]¶ Return a list of tasks mentioned in the paper.
- Parameters
paper_id (str) – ID of the paper.
- Returns
List of task objects.
- Return type
List[Task]
-
paper_method_list
(paper_id: str) → List[paperswithcode.models.method.Method][source]¶ Return a list of methods mentioned in the paper.
- Parameters
paper_id (str) – ID of the paper.
- Returns
List of method objects.
- Return type
List[Method]
-
paper_result_list
(paper_id: str) → List[paperswithcode.models.evaluation.result.Result][source]¶ Return a list of evaluation results for the paper.
- Parameters
paper_id (str) – ID of the paper.
- Returns
List of result objects.
- Return type
List[Result]
-
conference_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.conference.Conferences[source]¶ Return a paginated list of conferences.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Conferences object.
- Return type
-
conference_get
(conference_id: str) → paperswithcode.models.conference.Conference[source]¶ Return a conference by it’s ID.
- Parameters
conference_id (str) – ID of the conference.
- Returns
Conference object.
- Return type
-
proceeding_list
(conference_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.conference.Proceedings[source]¶ Return a paginated list of conference proceedings.
- Parameters
conference_id (str) – ID of the conference.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Proceedings object.
- Return type
-
proceeding_get
(conference_id: str, proceeding_id: str) → paperswithcode.models.conference.Proceeding[source]¶ Return a conference proceeding by it’s ID.
- Parameters
conference_id (str) – ID of the conference.
proceeding_id (str) – ID of the proceeding.
- Returns
Proceeding object.
- Return type
-
proceeding_paper_list
(conference_id: str, proceeding_id: str) → List[paperswithcode.models.paper.Paper][source]¶ Return a list of papers published in a confernce proceeding.
- Parameters
conference_id (str) – ID of the conference.
proceeding_id (str) – ID of the proceding.
- Returns
List of paper objects.
- Return type
List[Paper]
-
area_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Areas[source]¶ Return a paginated list of areas.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Areas object.
- Return type
-
area_get
(area_id: str) → paperswithcode.models.task.Area[source]¶ Return an area by it’s ID.
- Parameters
area_id (str) – ID of the area.
- Returns
Area object.
- Return type
-
area_task_list
(area_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks[source]¶ Return a paginated list of tasks in an area.
- Parameters
area_id (str) – ID of the area.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Tasks object.
- Return type
-
task_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks[source]¶ Return a paginated list of tasks.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Tasks object.
- Return type
-
task_get
(task_id: str) → paperswithcode.models.task.Task[source]¶ Return a task by it’s ID.
- Parameters
task_id (str) – ID of the task.
- Returns
Task object.
- Return type
-
task_paper_list
(task_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers[source]¶ Return a paginated list of papers for a selected task.
- Parameters
task_id (str) – ID of the task.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Papers object.
- Return type
-
task_evaluation_list
(task_id: str) → List[paperswithcode.models.evaluation.table.EvaluationTable][source]¶ Return a list of evaluation tables for a selected task.
- Parameters
task_id (str) – ID of the task.
- Returns
List of short evaluation table objects.
- Return type
List[EvaluationTable]
-
dataset_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.dataset.Datasets[source]¶ Return a paginated list of datasets.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Datasets object.
- Return type
-
dataset_get
(dataset_id: str) → paperswithcode.models.dataset.Dataset[source]¶ Return a dastaset by it’s ID.
- Parameters
dataset_id (str) – ID of the dataset.
- Returns
Dataset object.
- Return type
-
dataset_evaluation_list
(dataset_id: str) → List[paperswithcode.models.evaluation.table.EvaluationTable][source]¶ Return a list of evaluation tables for a selected dataset.
- Parameters
dataset_id (str) – ID of the dasaset.
- Returns
List of short evaluation table objects.
- Return type
List[EvaluationTable]
-
method_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.method.Methods[source]¶ Return a paginated list of methods.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Methods object.
- Return type
-
method_get
(method_id) → paperswithcode.models.method.Method[source]¶ Return a method by it’s ID.
- Parameters
method_id (str) – ID of the method.
- Returns
Method object.
- Return type
-
evaluation_list
(page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.table.EvaluationTables[source]¶ Return a paginated list of evaluation tables.
- Parameters
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.
- Returns
Evaluation table page object.
- Return type
-
evaluation_get
(evaluation_id: str) → paperswithcode.models.evaluation.table.EvaluationTable[source]¶ Return a evaluation table by it’s ID.
- Parameters
evaluation_id (str) – ID of the evaluation table.
- Returns
Evaluation table object.
- Return type
-
evaluation_create
(evaluation: paperswithcode.models.evaluation.table.EvaluationTableCreateRequest) → paperswithcode.models.evaluation.table.EvaluationTable[source]¶ Create an evaluation table.
- Parameters
evaluation (EvaluationTableCreateRequest) – Evaluation table create request object.
- Returns
The new created evaluation table.
- Return type
-
evaluation_update
(evaluation_id: str, evaluation: paperswithcode.models.evaluation.table.EvaluationTableUpdateRequest) → paperswithcode.models.evaluation.table.EvaluationTable[source]¶ Update an evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
evaluation (EvaluationTableUpdateRequest) – Evaluation table update request object.
- Returns
The updated evaluation table.
- Return type
-
evaluation_delete
(evaluation_id: str)[source]¶ Delete an evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
-
evaluation_metric_list
(evaluation_id: str) → List[paperswithcode.models.evaluation.metric.Metric][source]¶ List all metrics used in the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
- Returns
All metrics used in the evaluation table.
- Return type
List[Metric]
-
evaluation_metric_get
(evaluation_id: str, metric_id: str) → paperswithcode.models.evaluation.metric.Metric[source]¶ Get a metrics used in the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
metric_id (str) – ID of the metric.
- Returns
Requested metric.
- Return type
-
evaluation_metric_add
(evaluation_id: str, metric: paperswithcode.models.evaluation.metric.MetricCreateRequest) → paperswithcode.models.evaluation.metric.Metric[source]¶ Add a metrics to the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
metric (MetricCreateRequest) – Metric create request.
- Returns
Created metric.
- Return type
-
evaluation_metric_update
(evaluation_id: str, metric_id: str, metric: paperswithcode.models.evaluation.metric.MetricUpdateRequest) → paperswithcode.models.evaluation.metric.Metric[source]¶ Update a metrics in the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
metric_id (str) – ID of the metric.
metric (MetricCreateRequest) – Metric update request.
- Returns
Updated metric.
- Return type
-
evaluation_metric_delete
(evaluation_id: str, metric_id: str)[source]¶ Delete a metrics from the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
metric_id (str) – ID of the metric.
-
evaluation_result_list
(evaluation_id: str) → List[paperswithcode.models.evaluation.result.Result][source]¶ List all results from the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
- Returns
All results from the evaluation table.
- Return type
List[Result]
-
evaluation_result_get
(evaluation_id: str, result_id: str) → paperswithcode.models.evaluation.result.Result[source]¶ Get a result from the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
result_id (str) – ID of the result.
- Returns
Requested result.
- Return type
-
evaluation_result_add
(evaluation_id: str, result: paperswithcode.models.evaluation.result.ResultCreateRequest) → paperswithcode.models.evaluation.result.Result[source]¶ Add a result to the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
result (ResultCreateRequest) – Result create request.
- Returns
Created result.
- Return type
-
evaluation_result_update
(evaluation_id: str, result_id: str, result: paperswithcode.models.evaluation.result.ResultUpdateRequest) → paperswithcode.models.evaluation.result.Result[source]¶ Update a result in the evaluation table.
- Parameters
evaluation_id (str) – ID of the evaluation table.
result_id (str) – ID of the result.
result (ResultUpdateRequest) – Result update request.
- Returns
Updated result.
- Return type
-