Skip to content

Commit 7c1843d

Browse files
mroavimroavi
committed
Improve naming of functions
1 parent 9fe2797 commit 7c1843d

File tree

11 files changed

+32
-27
lines changed

11 files changed

+32
-27
lines changed

‎benchmark/bench_map.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ using Artifacts
77
const SUITE = BenchmarkGroup()
88

99
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
10-
problem = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
10+
problem = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1111

1212
optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40)
1313
tn = TensorNetworkModel(problem; optimizer)

‎benchmark/bench_mar.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ using Artifacts
99
const SUITE = BenchmarkGroup()
1010

1111
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
12-
problem = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
12+
problem = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1313

1414
optimizer = TreeSA(ntrials = 1, niters = 5, βs = 0.1:0.1:100)
1515
tn1 = TensorNetworkModel(problem; optimizer)

‎benchmark/bench_mmap.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ using Artifacts
77
const SUITE = BenchmarkGroup()
88

99
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
10-
problem = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
10+
problem = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1111
optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40)
1212

1313
# Does not marginalize any var

‎example/asia/asia.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
using TensorInference
22

33
# Load the model that detailed in the README and `asia.uai`.
4-
instance = uai_problem_from_file(joinpath(@__DIR__, "asia.uai"))
4+
instance = read_instance(joinpath(@__DIR__, "asia.uai"))
55
tnet = TensorNetworkModel(instance)
66

77
# Get the probabilities (PR)
@@ -36,4 +36,4 @@ mmap = MMAPModel(instance; marginalized=[1,2,3,5,6,8])
3636
most_probable_config(mmap)
3737
# The total probability of having lung cancer is roughly half.
3838
log_probability(mmap, [1, 0])
39-
log_probability(mmap, [0, 0])
39+
log_probability(mmap, [0, 0])

‎src/TensorInference.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export RescaledArray
1111
export contraction_complexity, TreeSA, GreedyMethod, KaHyParBipartite, SABipartite, MergeGreedy, MergeVectors
1212

1313
# read and load uai files
14-
export read_uai_file, read_td_file, read_uai_evid_file, read_uai_mar_file, uai_problem_from_file
14+
export read_model_file, read_td_file, read_evidence_file, read_solution_file, read_instance
1515
export set_evidence!
1616

1717
# marginals

‎src/utils.jl‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ format.
77
The UAI file formats are defined in:
88
https://personal.utdallas.edu/~vibhav.gogate/uai16-evaluation/uaiformat.html
99
"""
10-
function read_uai_file(uai_filepath; factor_eltype = Float64)
10+
function read_model_file(uai_filepath; factor_eltype = Float64)
1111
# Read the uai file into an array of lines
1212
str = open(uai_filepath) do file
1313
read(file, String)
1414
end
15-
return read_uai_string(str; factor_eltype)
15+
return read_model_string(str; factor_eltype)
1616
end
1717

18-
function read_uai_string(str; factor_eltype = Float64)
18+
function read_model_string(str; factor_eltype = Float64)
1919
rawlines = split(str, "\n")
2020
# Filter out empty lines
2121
lines = filter(!isempty, rawlines)
@@ -71,7 +71,7 @@ file path is an empty string, return empty vectors.
7171
The UAI file formats are defined in:
7272
https://personal.utdallas.edu/~vibhav.gogate/uai16-evaluation/uaiformat.html
7373
"""
74-
function read_uai_evid_file(uai_evid_filepath::AbstractString)
74+
function read_evidence_file(uai_evid_filepath::AbstractString)
7575
if isempty(uai_evid_filepath)
7676
# No evidence
7777
return Int64[], Int64[]
@@ -104,7 +104,7 @@ as in the model
104104
The UAI file formats are defined in:
105105
https://personal.utdallas.edu/~vibhav.gogate/uai16-evaluation/uaiformat.html
106106
"""
107-
function read_uai_mar_file(uai_mar_filepath::AbstractString; factor_eltype = Float64)
107+
function read_solution_file(uai_mar_filepath::AbstractString; factor_eltype = Float64)
108108

109109
# Read the uai mar file into an array of lines
110110
rawlines = open(uai_mar_filepath) do file
@@ -175,17 +175,22 @@ end
175175
"""
176176
$(TYPEDSIGNATURES)
177177
178-
Read a UAI problem from a file.
178+
Read a UAI problem instance from a file.
179179
"""
180-
function uai_problem_from_file(uai_filepath::String; uai_evid_filepath::String = "", uai_mar_filepath::String = "", eltype = Float64)::UAIInstance
181-
nvars, cards, ncliques, factors = read_uai_file(uai_filepath; factor_eltype = eltype)
182-
obsvars, obsvals = read_uai_evid_file(uai_evid_filepath)
183-
reference_marginals = isempty(uai_mar_filepath) ? Vector{eltype}[] : read_uai_mar_file(uai_mar_filepath)
180+
function read_instance(
181+
uai_filepath::AbstractString;
182+
uai_evid_filepath::AbstractString = "",
183+
uai_mar_filepath::AbstractString = "",
184+
eltype = Float64
185+
)::UAIInstance
186+
nvars, cards, ncliques, factors = read_model_file(uai_filepath; factor_eltype = eltype)
187+
obsvars, obsvals = read_evidence_file(uai_evid_filepath)
188+
reference_marginals = isempty(uai_mar_filepath) ? Vector{eltype}[] : read_solution_file(uai_mar_filepath)
184189
return UAIInstance(nvars, ncliques, cards, factors, obsvars, obsvals, reference_marginals)
185190
end
186191

187-
function uai_problem_from_string(uai::String; eltype = Float64)::UAIInstance
188-
nvars, cards, ncliques, factors = read_uai_string(uai; factor_eltype = eltype)
192+
function read_instance_from_string(uai::AbstractString; eltype = Float64)::UAIInstance
193+
nvars, cards, ncliques, factors = read_model_string(uai; factor_eltype = eltype)
189194
return UAIInstance(nvars, ncliques, cards, factors, Int[], Int[], Vector{eltype}[])
190195
end
191196

‎test/cuda.jl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CUDA.allowscalar(false)
66
@testset "gradient-based tensor network solvers" begin
77
################# Load problem ####################
88
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
9-
instance = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
9+
instance = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1010

1111
# does not optimize over open vertices
1212
tn = TensorNetworkModel(instance; optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40))
@@ -24,7 +24,7 @@ end
2424
@testset "map" begin
2525
################# Load problem ####################
2626
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
27-
instance = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
27+
instance = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
2828

2929
# does not optimize over open vertices
3030
tn = TensorNetworkModel(instance; optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40))
@@ -40,7 +40,7 @@ end
4040
@testset "mmap" begin
4141
################# Load problem ####################
4242
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
43-
instance = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
43+
instance = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
4444

4545
optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40)
4646
tn_ref = TensorNetworkModel(instance; optimizer)

‎test/inference.jl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ end
1313

1414
@testset "cached, rescaled contract" begin
1515
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
16-
problem = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
16+
problem = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1717
ref_sol = problem.reference_marginals
1818
optimizer = TreeSA(ntrials = 1, niters = 5, βs = 0.1:0.1:100)
1919
tn = TensorNetworkModel(problem; optimizer)
@@ -67,7 +67,7 @@ end
6767
@info "Testing: $problem"
6868
@testset "$(problem)" begin
6969
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths(problem, "MAR")
70-
problem = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
70+
problem = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
7171
ref_sol = problem.reference_marginals
7272
obsvars = problem.obsvars
7373

‎test/maxprob.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ using TensorInference
55
@testset "map" begin
66
################# Load problem ####################
77
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
8-
instance = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
8+
instance = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
99

1010
# does not optimize over open vertices
1111
tn = TensorNetworkModel(instance; optimizer = TreeSA(ntrials = 3, niters = 2, βs = 1:0.1:80))

‎test/mmap.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ end
1010
@testset "mmap" begin
1111
################# Load problem ####################
1212
model_filepath, evid_filepath, sol_filepath = get_instance_filepaths("Promedus_14", "MAR")
13-
instance = uai_problem_from_file(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
13+
instance = read_instance(model_filepath; uai_evid_filepath = evid_filepath, uai_mar_filepath = sol_filepath)
1414

1515
optimizer = TreeSA(ntrials = 1, niters = 2, βs = 1:0.1:40)
1616
tn_ref = TensorNetworkModel(instance; optimizer)

0 commit comments

Comments
 (0)