GithubHelp home page GithubHelp logo

Comments (1)

BradyPlanden avatar BradyPlanden commented on August 10, 2024

My current thoughts on an API for this is as follows:

problem = pybop.SingleOutputProblem(model, parameters, signal, dataset)
cost = pybop.SumofErrors(problem)
optim = pybop.Optimisation(cost,x0,method,bounds=bounds)
results = optim.run()

This essentially splits the functionality of our current pybop.Optimisation() class into more manageable classes with clearer divisions. This is similar to the pints classes, with a few differences around the Problem() class. In this structure, the SumofErrors class would inherit a base cost function class.

The functionality is as follows:

  1. The SingleOutputProblem stores the optimisation parameters, runs the model via model.simulate(), and returns the results with respect to the signal definition.
  2. The SumofErrors class calls the problem class and evaluates the returned prediction and the ground truth from the dataset.
  3. The Optimisation object wraps everything together and passes it to to selected optimiser. This class

Let me know if anyone has additional thoughts on this, or an alternative idea. Otherwise, I'm going to start implementing it and will open a PR for review once it's completed.

from pybop.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.