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.

search(q: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper_repo.PaperRepos [source]¶

Search in a similar fashion to the frontpage search.

Parameters

q (str, optional) – Filter papers by querying the paper title and abstract.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

PaperRepos object.

Return type

PaperRepos

paper_list(q: Optional[str] = None, arxiv_id: Optional[str] = None, title: Optional[str] = None, abstract: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers [source]¶

Return a paginated list of papers.

Parameters

q (str, optional) – Filter papers by querying the paper title and abstract.
arxiv_id (str, optional) – Filter papers by arxiv id.
title (str, optional) – Filter papers by part of the title.
abstract (str, optional) – Filter papers by part of the abstract.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Papers object.

Return type

Papers

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

paper_dataset_list(paper_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.repository.Repositories [source]¶

Return a list of datasets mentioned in the paper..

Parameters

paper_id (str) – ID of the paper.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Datasets object.

Return type

Datasets

paper_repository_list(paper_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.repository.Repositories [source]¶

Return a list of paper implementations.

Parameters

paper_id (str) – ID of the paper.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Repositories object.

Return type

Repositories

paper_task_list(paper_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks [source]¶

Return a list of tasks mentioned in the paper.

Parameters

paper_id (str) – ID of the paper.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Tasks object.

Return type

Tasks

paper_method_list(paper_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.method.Methods [source]¶

Return a list of methods mentioned in the paper.

Parameters

paper_id (str) – ID of the paper.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Methods object.

Return type

Methods

paper_result_list(paper_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.result.Results [source]¶

Return a list of evaluation results for the paper.

Parameters

paper_id (str) – ID of the paper.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Results object.

Return type

Results

repository_list(q: Optional[str] = None, owner: Optional[str] = None, name: Optional[str] = None, stars: Optional[int] = None, framework: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers [source]¶

Return a paginated list of repositories.

Parameters

q (str, optional) – Search all searchable fields.
owner (str, optional) – Filter repositories by owner.
name (str, optional) – Filter repositories by name.
stars (int, optional) – Filter repositories by minimum number of stars.
framework (str, optional) – Filter repositories by framework. Available values: tf, pytorch, mxnet, torch, caffe2, jax, paddle, mindspore.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Repositories object.

Return type

Repositories

repository_owner_list(owner: str) → paperswithcode.models.repository.Repositories [source]¶

List all repositories for a specific repo owner.

Parameters: owner (str) – Repository owner.
Returns: Repositories object.
Return type: Repositories

repository_get(owner: str, name: str) → paperswithcode.models.repository.Repository [source]¶

Return a repository by it’s owner/name pair.

Parameters

owner (str) – Owner name.
name (str) – Repository name.

Returns

Repository object.

Return type

Repository

repository_paper_list(owner: str, name: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers [source]¶

List all papers connected to the repository.

Parameters

owner (str) – Owner name.
name (str) – Repository name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Papers object.

Return type

Papers

author_list(q: Optional[str] = None, full_name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.author.Authors [source]¶

Return a paginated list of paper authors.

Parameters

q (str, optional) – Search all searchable fields.
full_name (str, optional) – Filter authors by part of their full name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Repositories object.

Return type

Repositories

author_get(author_id: str) → paperswithcode.models.author.Author [source]¶

Return a specific author selected by its id.

Parameters: author_id (str) – Author id.
Returns: Author object.
Return type: Author

author_paper_list(author_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers [source]¶

List all papers connected to the author.

Parameters

author_id (str) – Author id.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Papers object.

Return type

Papers

conference_list(q: Optional[str] = None, name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.conference.Conferences [source]¶

Return a paginated list of conferences.

Parameters

q (str, optional) – Search all searchable fields.
name (str, optional) – Filter conferences by part of the name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Conferences object.

Return type

Conferences

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: Conference

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

Proceedings

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

proceeding_paper_list(conference_id: str, proceeding_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.paper.Papers [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.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Papers object.

Return type

Papers

area_list(q: Optional[str] = None, name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Areas [source]¶

Return a paginated list of areas.

Parameters

q (str, optional) – Filter areas by querying the area name.
name (str, optional) – Filter areas by part of the name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Areas object.

Return type

Areas

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

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

Tasks

task_list(q: Optional[str] = None, name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks [source]¶

Return a paginated list of tasks.

Parameters

q (str, optional) – Filter tasks by querying the task name.
name (str, optional) – Filter tasks by part of th name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Tasks object.

Return type

Tasks

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

task_add(task: paperswithcode.models.task.TaskCreateRequest) → paperswithcode.models.task.Task [source]¶

Add a task.

Parameters: task (TaskCreateRequest) – Task create request.
Returns: Created task.
Return type: Task

task_update(task_id: str, task: paperswithcode.models.task.TaskUpdateRequest) → paperswithcode.models.task.Task [source]¶

Update a task.

Parameters

task_id (str) – ID of the task.
task (TaskUpdateRequest) – Task update request.

Returns

Updated task.

Return type

Task

task_delete(task_id: str)[source]¶

Delete a task.

Parameters: task_id (str) – ID of the task.

task_parent_list(task_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks [source]¶

Return a paginated list of parent tasks 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

Tasks object.

Return type

Tasks

task_child_list(task_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.task.Tasks [source]¶

Return a paginated list of child tasks 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

Tasks object.

Return type

Tasks

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

Papers

task_evaluation_list(task_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.table.EvaluationTables [source]¶

Return a list of evaluation tables 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

EvaluationTables object.

Return type

EvaluationTables

dataset_list(q: Optional[str] = None, name: Optional[str] = None, full_name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.dataset.Datasets [source]¶

Return a paginated list of datasets.

Parameters

q (str, optional) – Filter datasets by querying the dataset name.
name (str, optional) – Filter datasets by their name.
full_name (str, optional) – Filter datasets by their full name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Datasets object.

Return type

Datasets

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

dataset_add(dataset: paperswithcode.models.dataset.DatasetCreateRequest) → paperswithcode.models.dataset.Dataset [source]¶

Add a dataset.

Parameters: dataset (DatasetCreateRequest) – Dataset create request.
Returns: Created dataset.
Return type: Dataset

dataset_update(dataset_id: str, dataset: paperswithcode.models.dataset.DatasetUpdateRequest) → paperswithcode.models.dataset.Dataset [source]¶

Update a dataset.

Parameters

dataset_id (str) – ID of the dataset.
dataset (DatasetUpdateRequest) – Dataset update request.

Returns

Updated dataset.

Return type

Dataset

dataset_delete(dataset_id: str)[source]¶

Delete a dataset.

Parameters: dataset_id (str) – ID of the dataset.

dataset_evaluation_list(dataset_id: str, page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.table.EvaluationTables [source]¶

Return a list of evaluation tables for a selected dataset.

Parameters

dataset_id (str) – ID of the dasaset.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

EvaluationTables object.

Return type

EvaluationTables

method_list(q: Optional[str] = None, name: Optional[str] = None, full_name: Optional[str] = None, page: int = 1, items_per_page: int = 50) → paperswithcode.models.method.Methods [source]¶

Return a paginated list of methods.

Parameters

q (str, optional) – Search all searchable fields.
name (str, optional) – Filter methods by part of the name.
full_name (str, optional) – Filter methods by part of the full name.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Methods object.

Return type

Methods

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: Method

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

EvaluationTables

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: EvaluationTable

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: EvaluationTable

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

EvaluationTable

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, page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.metric.Metrics [source]¶

List all metrics used in the evaluation table.

Parameters

evaluation_id (str) – ID of the evaluation table.
page (int) – Desired page.
items_per_page (int) – Desired number of items per page. Default: 50.

Returns

Metrics object.

Return type

Metrics

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

Metric

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

Metric

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

Metric

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, page: int = 1, items_per_page: int = 50) → paperswithcode.models.evaluation.result.Results [source]¶