Merge pull request #10 from codingpot/refactor-6-paper-result-list

feat: implement PaperResultList

Author: deep-diver

dummy/paper_result_list.json

@@ -0,0 +1,31 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "id": "657bb1c5-de55-4afc-ba54-0af74eaab5e2",
+      "best_rank": 1,
+      "metrics": {
+        "mean iou (class)": "85.1%"
+      },
+      "methodology": "hrnet-ocr (hierarchical multi-scale attention)",
+      "uses_additional_data": false,
+      "paper": "hierarchical-multi-scale-attention-for",
+      "best_metric": "mean iou (class)",
+      "evaluated_on": "2020-05-21"
+    },
+    {
+      "id": "a0db982b-68a8-4685-921d-a8a557304c85",
+      "best_rank": null,
+      "metrics": {
+        "pq": "17.6"
+      },
+      "methodology": "hrnet-ocr (hierarchical multi-scale attention)",
+      "uses_additional_data": false,
+      "paper": "hierarchical-multi-scale-attention-for",
+      "best_metric": null,
+      "evaluated_on": "2020-05-21"
+    }
+  ]
+}

models/results.go

@@ -0,0 +1,21 @@
+package models
+
+type Result struct {
+	ID                 string            `json:"id"`
+	BestRank           *int              `json:"best_rank"`
+	Metrics            map[string]string `json:"metrics"`
+	Methodology        string            `json:"methodology"`
+	UsesAdditionalData bool              `json:"uses_additional_data"`
+	Paper              *string           `json:"paper"`
+	BestMetric         *string           `json:"best_metric"`
+	EvaluatedOn        YyyyMmDdDashed    `json:"evaluated_on"`
+	ExternalSourceUrl  *string           `json:"external_source_url"`
+}
+
+// ResultList contains results produced in a paper.
+type ResultList struct {
+	Count    int     `json:"count"`
+	Next     *string `json:"next"`
+	Previous *string `json:"previous"`
+	Results  []*Result
+}

models/yyyymmdd.go

@@ -21,3 +21,7 @@ func (y *YyyyMmDdDashed) UnmarshalJSON(bytes []byte) error {
 func (y YyyyMmDdDashed) MarshalJSON() ([]byte, error) {
 	return json.Marshal(y)
 }
+
+func NewYyyyMmDdDashed(year int, month time.Month, day int) YyyyMmDdDashed {
+	return YyyyMmDdDashed(time.Date(year, month, day, 0, 0, 0, 0, time.UTC))
+}

paper_result_list.go

@@ -0,0 +1,25 @@
+package paperswithcode_go
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/codingpot/paperswithcode-go/models"
+	"net/url"
+)
+
+func (c *Client) PaperResultList(paperID string) (*models.ResultList, error) {
+	pURL := fmt.Sprintf("%s/papers/%s/results", c.BaseURL, url.QueryEscape(paperID))
+
+	resp, err := c.HTTPClient.Get(pURL)
+	if err != nil {
+		return nil, err
+	}
+
+	var paperResultList models.ResultList
+	err = json.NewDecoder(resp.Body).Decode(&paperResultList)
+	if err != nil {
+		return nil, err
+	}
+
+	return &paperResultList, nil
+}

paper_result_list_test.go

@@ -0,0 +1,52 @@
+package paperswithcode_go
+
+import (
+	"github.com/codingpot/paperswithcode-go/models"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+var one int = 1
+
+func TestClient_PaperResultList(t *testing.T) {
+	paperID := "hierarchical-multi-scale-attention-for"
+	bestMetric := "Mean IoU (class)"
+
+	c := NewClient()
+	got, err := c.PaperResultList(paperID)
+	assert.NoError(t, err)
+
+	expected := &models.ResultList{
+		Count:    2,
+		Next:     nil,
+		Previous: nil,
+		Results: []*models.Result{
+			{
+				ID:       "657bb1c5-de55-4afc-ba54-0af74eaab5e2",
+				BestRank: &one,
+				Metrics: map[string]string{
+					bestMetric: "84.2",
+				},
+				Methodology:        "HRNet-OCR (Hierarchical Multi-Scale Attention)",
+				UsesAdditionalData: false,
+				Paper:              &paperID,
+				BestMetric:         &bestMetric,
+				EvaluatedOn:        models.NewYyyyMmDdDashed(2020, 5, 21),
+			},
+			{
+				ID:       "a0db982b-68a8-4685-921d-a8a557304c85",
+				BestRank: nil,
+				Metrics: map[string]string{
+					"PQ": "17.6",
+				},
+				Methodology:        "HRNet-OCR (Hierarchical Multi-Scale Attention)",
+				UsesAdditionalData: false,
+				Paper:              &paperID,
+				BestMetric:         nil,
+				EvaluatedOn:        models.NewYyyyMmDdDashed(2020, 5, 21),
+			},
+		},
+	}
+
+	assert.Equal(t, expected, got)
+}