source: trunk/sources/HeuristicLab.Problems.ExternalEvaluation/3.4/ExternalEvaluationProblem.cs @ 13491

Last change on this file since 13491 was 13491, checked in by abeham, 5 years ago

#2551: made Encoding public get/set for external evaluation problems

File size: 8.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using System.Threading;
27using Google.ProtocolBuffers;
28using HeuristicLab.Analysis;
29using HeuristicLab.Common;
30using HeuristicLab.Core;
31using HeuristicLab.Data;
32using HeuristicLab.Optimization;
33using HeuristicLab.Parameters;
34using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
35
36namespace HeuristicLab.Problems.ExternalEvaluation {
37  [Item("External Evaluation Problem (single-objective)", "A problem that is evaluated in a different process.")]
38  [Creatable(CreatableAttribute.Categories.ExternalEvaluationProblems, Priority = 100)]
39  [StorableClass]
40  // BackwardsCompatibility3.3
41  // Rename class to SingleObjectiveExternalEvaluationProblem
42  public class ExternalEvaluationProblem : SingleObjectiveBasicProblem<IEncoding>, IExternalEvaluationProblem {
43
44    public static new Image StaticItemImage {
45      get { return HeuristicLab.Common.Resources.VSImageLibrary.Type; }
46    }
47
48    #region Parameters
49    public OptionalValueParameter<EvaluationCache> CacheParameter {
50      get { return (OptionalValueParameter<EvaluationCache>)Parameters["Cache"]; }
51    }
52    public IValueParameter<CheckedItemCollection<IEvaluationServiceClient>> ClientsParameter {
53      get { return (IValueParameter<CheckedItemCollection<IEvaluationServiceClient>>)Parameters["Clients"]; }
54    }
55    public IValueParameter<SolutionMessageBuilder> MessageBuilderParameter {
56      get { return (IValueParameter<SolutionMessageBuilder>)Parameters["MessageBuilder"]; }
57    }
58    public IFixedValueParameter<SingleObjectiveOptimizationSupportScript> SupportScriptParameter {
59      get { return (IFixedValueParameter<SingleObjectiveOptimizationSupportScript>)Parameters["SupportScript"]; }
60    }
61    #endregion
62
63    #region Properties
64    public new IEncoding Encoding {
65      get { return base.Encoding; }
66      set { base.Encoding = value; }
67    }
68    public EvaluationCache Cache {
69      get { return CacheParameter.Value; }
70    }
71    public CheckedItemCollection<IEvaluationServiceClient> Clients {
72      get { return ClientsParameter.Value; }
73    }
74    public SolutionMessageBuilder MessageBuilder {
75      get { return MessageBuilderParameter.Value; }
76    }
77    public SingleObjectiveOptimizationSupportScript OptimizationSupportScript {
78      get { return SupportScriptParameter.Value; }
79    }
80    private ISingleObjectiveOptimizationSupport OptimizationSupport {
81      get { return SupportScriptParameter.Value; }
82    }
83    #endregion
84
85    [StorableConstructor]
86    protected ExternalEvaluationProblem(bool deserializing) : base(deserializing) { }
87    protected ExternalEvaluationProblem(ExternalEvaluationProblem original, Cloner cloner) : base(original, cloner) { }
88    public override IDeepCloneable Clone(Cloner cloner) {
89      return new ExternalEvaluationProblem(this, cloner);
90    }
91    public ExternalEvaluationProblem()
92      : base() {
93      Parameters.Remove("Maximization"); // readonly in base class
94      Parameters.Add(new FixedValueParameter<BoolValue>("Maximization", "Set to false if the problem should be minimized.", new BoolValue()));
95      Parameters.Add(new OptionalValueParameter<EvaluationCache>("Cache", "Cache of previously evaluated solutions."));
96      Parameters.Add(new ValueParameter<CheckedItemCollection<IEvaluationServiceClient>>("Clients", "The clients that are used to communicate with the external application.", new CheckedItemCollection<IEvaluationServiceClient>() { new EvaluationServiceClient() }));
97      Parameters.Add(new ValueParameter<SolutionMessageBuilder>("MessageBuilder", "The message builder that converts from HeuristicLab objects to SolutionMessage representation.", new SolutionMessageBuilder()) { Hidden = true });
98      Parameters.Add(new FixedValueParameter<SingleObjectiveOptimizationSupportScript>("SupportScript", "A script that can provide neighborhood and analyze the results of the optimization.", new SingleObjectiveOptimizationSupportScript()));
99
100      Operators.Add(new BestScopeSolutionAnalyzer());
101    }
102
103    #region Single Objective Problem Overrides
104    public override bool Maximization {
105      get { return Parameters.ContainsKey("Maximization") && ((IValueParameter<BoolValue>)Parameters["Maximization"]).Value.Value; }
106    }
107
108    public override double Evaluate(Individual individual, IRandom random) {
109      var qualityMessage = Evaluate(BuildSolutionMessage(individual));
110      if (!qualityMessage.HasExtension(SingleObjectiveQualityMessage.QualityMessage_))
111        throw new InvalidOperationException("The received message is not a SingleObjectiveQualityMessage.");
112      return qualityMessage.GetExtension(SingleObjectiveQualityMessage.QualityMessage_).Quality;
113    }
114    public virtual QualityMessage Evaluate(SolutionMessage solutionMessage) {
115      return Cache == null
116        ? EvaluateOnNextAvailableClient(solutionMessage)
117        : Cache.GetValue(solutionMessage, EvaluateOnNextAvailableClient, GetQualityMessageExtensions());
118    }
119
120    public override void Analyze(Individual[] individuals, double[] qualities, ResultCollection results, IRandom random) {
121      OptimizationSupport.Analyze(individuals, qualities, results, random);
122    }
123
124    public override IEnumerable<Individual> GetNeighbors(Individual individual, IRandom random) {
125      return OptimizationSupport.GetNeighbors(individual, random);
126    }
127    #endregion
128
129    public virtual ExtensionRegistry GetQualityMessageExtensions() {
130      var extensions = ExtensionRegistry.CreateInstance();
131      extensions.Add(SingleObjectiveQualityMessage.QualityMessage_);
132      return extensions;
133    }
134
135    #region Evaluation
136    private HashSet<IEvaluationServiceClient> activeClients = new HashSet<IEvaluationServiceClient>();
137    private object clientLock = new object();
138
139    private QualityMessage EvaluateOnNextAvailableClient(SolutionMessage message) {
140      IEvaluationServiceClient client = null;
141      lock (clientLock) {
142        client = Clients.CheckedItems.FirstOrDefault(c => !activeClients.Contains(c));
143        while (client == null && Clients.CheckedItems.Any()) {
144          Monitor.Wait(clientLock);
145          client = Clients.CheckedItems.FirstOrDefault(c => !activeClients.Contains(c));
146        }
147        if (client != null)
148          activeClients.Add(client);
149      }
150      try {
151        return client.Evaluate(message, GetQualityMessageExtensions());
152      } finally {
153        lock (clientLock) {
154          activeClients.Remove(client);
155          Monitor.PulseAll(clientLock);
156        }
157      }
158    }
159
160    private SolutionMessage BuildSolutionMessage(Individual individual, int solutionId = 0) {
161      lock (clientLock) {
162        SolutionMessage.Builder protobufBuilder = SolutionMessage.CreateBuilder();
163        protobufBuilder.SolutionId = solutionId;
164        var scope = new Scope();
165        individual.CopyToScope(scope);
166        foreach (var variable in scope.Variables) {
167          try {
168            MessageBuilder.AddToMessage(variable.Value, variable.Name, protobufBuilder);
169          } catch (ArgumentException ex) {
170            throw new InvalidOperationException(string.Format("ERROR while building solution message: Parameter {0} cannot be added to the message", Name), ex);
171          }
172        }
173        return protobufBuilder.Build();
174      }
175    }
176    #endregion
177  }
178}
Note: See TracBrowser for help on using the repository browser.