LibtorchArtificialNeuralNet.h File Reference

Go to the source code of this file.

Classes
class	Moose::LibtorchArtificialNeuralNet
	Simple feed-forward neural net with optional affine input and output scaling. More...

Namespaces
namespace	Moose
	MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to address this in their environment if C++17 compatibility isn't found.

Functions
void	Moose::to_json (nlohmann::json &json, const Moose::LibtorchArtificialNeuralNet *const &network)
	Dump an artificial neural network into JSON for reporter output and debugging.
void	Moose::loadLibtorchArtificialNeuralNetState (Moose::LibtorchArtificialNeuralNet &nn, const std::string &filename)
	Load an artificial-neural-network checkpoint written as a native libtorch state archive.
template<>
void	dataStore< Moose::LibtorchArtificialNeuralNet > (std::ostream &stream, std::shared_ptr< Moose::LibtorchArtificialNeuralNet > &nn, void *context)
	Serialize the artificial-neural-network metadata needed for restart.
template<>
void	dataLoad< Moose::LibtorchArtificialNeuralNet > (std::istream &stream, std::shared_ptr< Moose::LibtorchArtificialNeuralNet > &nn, void *context)
	Deserialize the artificial-neural-network metadata needed for restart.
template<>
void	dataStore< Moose::LibtorchArtificialNeuralNet const > (std::ostream &stream, Moose::LibtorchArtificialNeuralNet const *&nn, void *context)
	Placeholder serializer for reporter-only artificial-neural-network pointers.
template<>
void	dataLoad< Moose::LibtorchArtificialNeuralNet const > (std::istream &stream, Moose::LibtorchArtificialNeuralNet const *&nn, void *context)
	Placeholder deserializer for reporter-only artificial-neural-network pointers.

Function Documentation

dataLoad< Moose::LibtorchArtificialNeuralNet >()

template<>

void dataLoad< Moose::LibtorchArtificialNeuralNet >	(	std::istream &	stream,
		std::shared_ptr< Moose::LibtorchArtificialNeuralNet > &	nn,
		void *	context
	)

Deserialize the artificial-neural-network metadata needed for restart.

Parameters

stream	Stream that provides the serialized data.
nn	Artificial neural network shared pointer to populate.
context	Serialization context passed through MOOSE data I/O.

Definition at line 516 of file LibtorchArtificialNeuralNet.C.

{
  std::string name;
  dataLoad(stream, name, context);
 
  unsigned int num_inputs;
  dataLoad(stream, num_inputs, context);
 
  unsigned int num_outputs;
  dataLoad(stream, num_outputs, context);
 
  unsigned int num_hidden_layers;
  dataLoad(stream, num_hidden_layers, context);
 
  std::vector<unsigned int> num_neurons_per_layer;
  num_neurons_per_layer.resize(num_hidden_layers);
  dataLoad(stream, num_neurons_per_layer, context);
 
  unsigned int num_activation_items;
  dataLoad(stream, num_activation_items, context);
 
  std::vector<std::string> activation_functions;
  activation_functions.resize(num_activation_items);
  dataLoad(stream, activation_functions, context);
 
  std::underlying_type<torch::DeviceType>::type device_type;
  dataLoad(stream, device_type, context);
  const torch::DeviceType divt(static_cast<torch::DeviceType>(device_type));
 
  std::underlying_type<torch::ScalarType>::type data_type;
  dataLoad(stream, data_type, context);
  const torch::ScalarType datt(static_cast<torch::ScalarType>(data_type));
 
  nn = std::make_shared<Moose::LibtorchArtificialNeuralNet>(
      name, num_inputs, num_outputs, num_neurons_per_layer, activation_functions, divt, datt);
 
  Moose::loadLibtorchArtificialNeuralNetState(*nn, name);
}

dataLoad< Moose::LibtorchArtificialNeuralNet const >()

template<>

void dataLoad< Moose::LibtorchArtificialNeuralNet const >	(	std::istream &	stream,
		Moose::LibtorchArtificialNeuralNet const *&	nn,
		void *	context
	)

Placeholder deserializer for reporter-only artificial-neural-network pointers.

Parameters

stream	Stream that would provide the serialized data.
nn	Reporter neural network pointer.
context	Serialization context passed through MOOSE data I/O.

Definition at line 567 of file LibtorchArtificialNeuralNet.C.

{
}

dataStore< Moose::LibtorchArtificialNeuralNet >()

template<>

void dataStore< Moose::LibtorchArtificialNeuralNet >	(	std::ostream &	stream,
		std::shared_ptr< Moose::LibtorchArtificialNeuralNet > &	nn,
		void *	context
	)

Serialize the artificial-neural-network metadata needed for restart.

Parameters

stream	Stream that receives the serialized data.
nn	Artificial neural network shared pointer to serialize.
context	Serialization context passed through MOOSE data I/O.

Definition at line 478 of file LibtorchArtificialNeuralNet.C.

{
  std::string n(nn->name());
  dataStore(stream, n, context);
 
  unsigned int ni(nn->numInputs());
  dataStore(stream, ni, context);
 
  unsigned int no(nn->numOutputs());
  dataStore(stream, no, context);
 
  unsigned int nhl(nn->numHiddenLayers());
  dataStore(stream, nhl, context);
 
  std::vector<unsigned int> nnpl(nn->numNeuronsPerLayer());
  dataStore(stream, nnpl, context);
 
  unsigned int afs(nn->activationFunctions().size());
  dataStore(stream, afs, context);
 
  std::vector<std::string> items(afs);
  for (unsigned int i = 0; i < afs; ++i)
    items[i] = nn->activationFunctions()[i];
 
  dataStore(stream, items, context);
 
  auto device_type = static_cast<std::underlying_type<torch::DeviceType>::type>(nn->deviceType());
  dataStore(stream, device_type, context);
 
  auto data_type = static_cast<std::underlying_type<torch::ScalarType>::type>(nn->dataType());
  dataStore(stream, data_type, context);
 
  torch::save(nn, nn->name());
}

dataStore< Moose::LibtorchArtificialNeuralNet const >()

template<>

void dataStore< Moose::LibtorchArtificialNeuralNet const >	(	std::ostream &	stream,
		Moose::LibtorchArtificialNeuralNet const *&	nn,
		void *	context
	)

Placeholder serializer for reporter-only artificial-neural-network pointers.

Parameters

stream	Stream that would receive the serialized data.
nn	Reporter neural network pointer.
context	Serialization context passed through MOOSE data I/O.

Definition at line 558 of file LibtorchArtificialNeuralNet.C.

{
}