package nice2protos

Get desktop application:
View/edit binary Protocol Buffers messages

The following defines Nice2Predict server RPC interface

• rpc Infer (Query, InferResponse)

  service.proto:13

  Infer query initiates MAP inference of unknown labels based on features and known assignemnts provided. The response contains best assignments.

  message InferResponse

  interface.proto:77

  InferResponse consists of assignments that were marked as to be inferred in the InferQuery.

  • repeated NodeAssignment node_assignments = 1

• rpc NBest (NBestQuery, NBestResponse)

  service.proto:16

  NBest query runs the MAP inference if necessary. The response contains N candidates for each assignment together with their scores.

  message NBestQuery

  interface.proto:61

  • optional Query query = 1

  • int32 n = 2

    Number of candidates to be returned for each assignemnt.

  • bool should_infer = 3

    Whether the inference already performed.

  message NBestResponse

  interface.proto:81

  • repeated NBestResponse.AssignmentCandidateDistribution candidates_distributions = 1

• rpc ShowGraph (ShowGraphQuery, ShowGraphResponse)

  service.proto:19

  ShowGraph query runs the MAP inference if necessary. The response contains an inference graph encoded in ShowGraphResponse format.

  message ShowGraphQuery

  interface.proto:69

  • optional Query query = 1

  • bool should_infer = 2

    Whether the inference already performed.

  message ShowGraphResponse

  interface.proto:96

  ShowGraph repsonse contains a graph in a format below and aimed to be shown.

  • repeated ShowGraphResponse.GraphNode nodes = 1

    Graph is represented as a lis of nodes and a list of edges.

  • repeated ShowGraphResponse.GraphEdge edges = 2

Feature describes a single feature extracted from a source program. Features specify relations between assignments that are reffered by indices. Indices are supposed to cover a full range from 0 to the number of assignments.

Used in: Query

• oneof feature

  A Feature is either a BinaryRelation, a Constraint or a FactorVariable.

  • Feature.BinaryRelation binary_relation = 1

  • Feature.InequalityConstraint constraint = 2

  • Feature.FactorVariable factor_variables = 3

BinaryRelation defines a binary relation between a pair of assignments.

Used in: Feature

• int32 first_node = 1

  Assignment indices.

• int32 second_node = 2

• string relation = 3

  Either AST tree or functional relation betweeen a pair assignments encoded in a string format.

Factor variable specify a group of assignments to be considered as factor variables. Factor variables should be enabled by a corresponding server flag to make this type of feature available.

Used in: Feature

• repeated int32 nodes = 1

Constraint defines a scoped-infered constraint over a group of assignments.

Used in: Feature

• repeated int32 nodes = 1

  Indices of constrainted assignments.

Assignment candidate distribution contains possible assignments together with their scores.

Used in: NBestResponse

• repeated AssignmentCandidateDistribution.AssignmentCandidate candidates = 1

• uint32 node = 2

Used in: AssignmentCandidateDistribution

• optional NodeAssignment node_assignment = 1

• double score = 2

An Assignment defines a label corresponding to a specifix index used in features enumeration. The label might be either given or unknown (i.e. supposed to be infered)

Used in: InferResponse, NBestResponse.AssignmentCandidateDistribution.AssignmentCandidate, Query

• string label = 1

  The name of the property.

• bool given = 2

  Whether the name is given or should be inferred.

• uint32 node_index = 3

Message containing all the information that is necessary to perform MAP inference and obtain labels that are not given.

Used as request type in: Nice2Service.Infer

Used as field type in: NBestQuery, ShowGraphQuery

• repeated Feature features = 1

• repeated NodeAssignment node_assignments = 2

A connection between a pair of nodes representing BinaryRelation feature.

Used in: ShowGraphResponse

• int32 id = 1

• string label = 2

• int32 source = 3

  Indices of a pair of nodes.

• int32 target = 4

The graph contains one node per each assignment.

Used in: ShowGraphResponse

• int32 id = 1

  The initial assignment id.

• string label = 2

  Either given or inferred label.

• string color = 3

  Color that represents whether the label has been given or inferred.