trecrun

package module

v0.0.0-...-cfdb0f1 Latest Latest Go to latest Published: Jan 24, 2018 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hscells/trecrun

Links

Open Source Insights

README ¶

trecrun

go get github.com/hscells/trecrun

trecrun deals with the deserialization of output from trec_eval-style run files. This package is inspired by the companion go library https://github.com/TimothyJones/trecresults.

Usage

rf, err := trecrun.RunsFromReader(f)
if err != nil {
    log.Fatal(err)
}

// p@5 for topic 1.
fmt.Println(rf.Runs[1].Measurement["P_5"])

// p@5 for all.
fmt.Println(rf.Measurement["P_5"])

Documentation ¶

Overview ¶

Package trecrun deals with the deserialization of output from trec_eval-style run files. This package is inspired by the companion go library https://github.com/TimothyJones/trecresults.

Index ¶

type Result
- func NewResult() *Result
- func (r *Result) Add(measurement string, value float64)
type Run
- func NewRun(topic int64) *Run
- func (r *Run) Add(measurement string, value float64)
type RunFile
- func RunsFromReader(reader io.Reader) (rf RunFile, err error)
type Runs

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Result ¶

type Result struct {
	RunId       string
	Measurement map[string]float64
}

Result is the summary of the runs.

func NewResult ¶

func NewResult() *Result

NewResult creates a new result.

func (*Result) Add ¶

func (r *Result) Add(measurement string, value float64)

Add adds a measurement and its associated value to the results.

type Run ¶

type Run struct {
	Topic       int64
	Measurement map[string]float64
}

Run is the measurements computed for a topic.

func NewRun ¶

func NewRun(topic int64) *Run

NewRun creates a new run with a topic.

func (*Run) Add ¶

func (r *Run) Add(measurement string, value float64)

Add adds a measurement and its associated value to the run.

type RunFile ¶

type RunFile struct {
	Runs
	Result
}

RunFile is the union of runs and a result.

func RunsFromReader ¶

func RunsFromReader(reader io.Reader) (rf RunFile, err error)

RunsFromReader creates a run file (the runs and result summary) from a reader.

type Runs ¶

type Runs map[int64]Run

Runs are the measurements completed for an experiment.

Source Files ¶

View all Source files

run.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL