U d[-@sddlmZmZmZddlmZddlmZddlm Z ddl m Z m Z ddl mZddlmZmZddlmZdd lZd d d d ddddddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6g-ZGd7d8d8eZd;d9d:Zd S)<)corescope workspace)db_input)parameter_info)parameter_sharing_context)OptimizerContext DEFAULT_OPTIM)RegularizerContext) viewitemsviewkeys)chainNZAccuracyZAdamZAddZAdagradZ SparseAdagradZAdadeltaZSparseAdadeltaZ AveragedLossZCastZ CheckpointZ ConstantFillZCopyZ CopyGPUToCPUZ CopyCPUToGPUZ DequeueBlobsZEnsureCPUOutputZ ExpandDimsZFlattenZ FlattenToVecZLabelCrossEntropyZ LearningRateZ MakeTwoClassZMatMulZ NCCLAllreduceZ NHWC2NCHWZ PackSegmentsZPrintZPReluZReduceFrontSumZScaleZScatterWeightedSumZSigmoidZSortedSegmentSumZSnapshotZSoftmaxZSoftmaxWithLossZSquaredL2DistanceZSqueeze StopGradientZ SummarizeZTanhZ TransposeZUnpackSegmentsZ WeightedSumZ YellowFinc@seZdZdZd?ddZeddZd d Zd d Zd dZ ddZ d@ddZ ddZ dAddZ dBddZeddZdCddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(ZdDd)d*Zd+d,Zd-d.ZdEd/d0ZdFd1d2Zd3d4Zd5d6Zd7d8Zd9d:Z d;d<Z!d=d>Z"dS)G ModelHelperaA helper model so we can manange models more easily. It contains net def and parameter storages. You can add an Operator yourself, e.g. model = model_helper.ModelHelper(name="train_net") # init your weight and bias as w and b w = model.param_init_net.XavierFill(...) b = model.param_init_net.ConstantFill(...) fc1 = model.FC([input, w, b], output, **kwargs) or you can use helper functions in brew module without manually defining parameter initializations and operators. model = model_helper.ModelHelper(name="train_net") fc1 = brew.fc(model, input, output, dim_in, dim_out, **kwargs) NTFcCs|pd|_t|j|_|dk rJ|j|_|j|_|j|_|j|_|j|_n*t|jd|_i|_g|_i|_g|_g|_ g|_ d|_ ||_ ||_ ||_g|_g|_dddd|_|dk r|j|dS)Nmodel_initFZNCHWT)orderZ use_cudnnZcudnn_exhaustive_search)namerNetnetparam_init_net param_to_gradparams_parameters_info_computed_params_param_info_deprecated_devicesgradient_ops_added init_paramsallow_not_known_opsskip_sparse_optimweightsbiases _arg_scopeupdate)selfrrrr Z param_model arg_scoper'>/tmp/pip-unpacked-wheel-ua33x9lu/caffe2/python/model_helper.py__init__^s6  zModelHelper.__init__cCs|jSN)r#r%r'r'r(r&szModelHelper.arg_scopecCs|jSr*)rr+r'r'r(get_nameszModelHelper.get_namecCsL|jjD]:}t||jkr |jD] }|jdkr$t|jSq$q dS)Nshape) rProtoopstroutputargrlistZints)r%paramr/r2r'r'r(_infer_param_shapes   zModelHelper._infer_param_shapec Cst|jt|jkst|jt|jdD]D}t|tjsLtdt||j t j t|j|| |dq,|jD]}|j |j|_qxdS)N!Param %s must be a BlobReference!)param_idr4r-)lenrrAssertionError isinstancer BlobReference ValueErrorr0appendr ParameterInfor5rgetrgrad)r%r4infor'r'r(_update_param_info_deprecateds     z)ModelHelper._update_param_info_deprecatedcCs$|pg}t|trt|St|gSr*)r:r3set)r%tagsr'r'r(_normalize_tagsszModelHelper._normalize_tagsc Cst|tjrt|}nt|tr,t|}ntd||jkr^|j|j|ksRt |j|j S|j t||j |d}t }||D]}||r|||_q|js|tr|t|_t}||_||j|<||j ||j S)a Creates parameter with a given name and initializer. If param_name is instance of BlobRefernce - then this blob will be used to store parameter (no any logic will affect it's location). If param_name is instance of a string type, then the final blob will be created in the CurrentNameScope with the respect of all parameter sharing logic, i.e. 'resolved_name_scope/param_name'. Parameter sharing logic is going to override CurrentNameScope according to the rules that are specified through ParameterSharing contexts, all ParameterSharing contexts are applied recursively until there are no extra overrides present, where on each step the best match will be applied first. The following examples should clarify the way ParameterSharing logic works: As an example if this function is called with parameter 'w': a. Call from some scope 'global_scope' with no Parameter sharing: 'global_scope/w' b. Call from scope 'scope_b', with override {'scope_b': 'scope_a'}: 'scope_a/w' c. Call from scope 'scope_a', with override {'scope_a': ''}: 'scope_a/w' d. Call from scope 'scope_b/shared', with overrides {'scope_b/shared': 'scope_b', 'scope_b': 'scope_a'}: 'scope_a/w' d. Call from scope 'scope_b/unshared', with overrides {'scope_b/shared': 'scope_b', 'scope_b': 'scope_a'}: 'scope_a/unshared/w' zUnsupported type for param_name) param_nameZinit_netr-)r:rr;r0rZget_parameter_name TypeErrorrr-r9Zblob create_paramrrcurrentrEZ has_optimizerZ get_optimizerZ optimizerr r Z regularizer AddParameter) r%rFr-Z initializerrD param_infoZ optim_contexttagZ reg_contextr'r'r(rHs4%        zModelHelper.create_paramcCs(t|tjstd||j|dS)NzParam {} is not a BlobReference)r:rr;r9formatrr?)r%r4r'r'r(get_param_infoszModelHelper.get_param_infoc Cstd||||dk rX|jdk rX|j|}|j|}|dk rd|n| |}t |t j st dt||jtjt|j||||d|jdS)Nzadd_param method is DEPRECATEDr6)r7r4r-keylength)loggingwarningrBrJrZ input_recordZ field_blobsindex field_namesr5r:rr;r<r0rr=rr>r8)r%r4rOr-rPidxr'r'r(add_param_DEPRECATEDs"    z ModelHelper.add_param_DEPRECATEDcCstt|tjst||}tjj|kr4|j |n |j |tjj |krX|j |tjj |krp|j |dSr*)r:rr;r9rErZ ParameterTagsZCOMPUTED_PARAMrr=rZWEIGHTr!ZBIASr")r%r4rDr'r'r(rJs      zModelHelper.AddParametercCs6|dkrtS|dks$|tjr(|S|tjSdS)N)rZCurrentNameScopeendswithZ_NAMESCOPE_SEPARATOR namescoper'r'r(_NormalizeNamescopes zModelHelper._NormalizeNamescopecs8tdkr |jddSfdd|jDSdS)z9 Returns the params in current namescope rXNcsg|]}|r|qSr'Z GetNameScope startswith.0prZr'r( $sz)ModelHelper.GetParams..)rr\r)r%r[Z top_scoper'rZr( GetParamss zModelHelper.GetParamscCs |jSr*)rr.r+r'r'r(r.'szModelHelper.ProtocCs |jSr*)rr.r+r'r'r( InitProto*szModelHelper.InitProtocOs |jj|||jj||dSr*)r RunAllOnGPUr)r%argskwargsr'r'r(re-szModelHelper.RunAllOnGPUcKs |jjg|f||d|}|S)N)dbdb_type)rCreateDB)r%blob_outrhrirgZdbreaderr'r'r(rj1szModelHelper.CreateDBcOs|jrtd|d|_|jj|||_||j|_|j D]4\}}| |}|rb||_ qDt j d||d|j|<qD|jS)Nz*You cannot run AddGradientOperators twice.T)r7r4r@)r RuntimeErrorValidaterAddGradientOperatorsgrad_mapget_param_to_gradrritemsrNr@rr>r)r%rfrgr4r@rKr'r'r(rn6s  z ModelHelper.AddGradientOperatorscCs@i}|jstd|D]$}t||jkr|jt|||<q|S)zp Given a list of parameters returns a dict from a parameter to a corresponding gradient z+You need to run AddGradientOperators first.)rrlr0ro)r%rrrar'r'r(rpNszModelHelper.get_param_to_gradcs8jstdj}|r"|}fddt|DS)zy Returns a map for param => grad. If params is not specified, all parameters will be considered. z'Need to call AddGradientOperators firstcs,g|]$\}}jrt|tjs|qSr')r r:rZ GradientSlicerN)r`r4r@r+r'r(rbjs z8ModelHelper.GetOptimizationParamInfo..)rrlrrpr )r%rrr'r+r(GetOptimizationParamInfo^s  z$ModelHelper.GetOptimizationParamInfocCstdd|jD}t|}g}t|t|krpt|}t|D]2\}}|dkr<||d|kr<||kr<||q<|S)z, Check for duplicate params cSsg|] }t|qSr'r0r_r'r'r(rbvsz)ModelHelper._Validate..r)rrCr8sorted enumerater=)r%Z params_listZ params_setdupesjrar'r'r( _Validaters zModelHelper._ValidatecCs"|}|gkstd|dS)NzDuplicate params: {})ryr9rM)r%rwr'r'r(rmszModelHelper.Validatecs8tdkr |jddSfdd|jDSdS)a Returns the computed params in current namescope. 'Computed params' are such parameters that are not optimized via gradient descent but are directly computed from data, such as the running mean and variance of Spatial Batch Normalization. rXNcsg|]}|r|qSr'r]r_rZr'r(rbsz1ModelHelper.GetComputedParams..)rr\rr%r[r'rZr(GetComputedParamss zModelHelper.GetComputedParamscCs||||Sr*)rcr{rzr'r'r( GetAllParamsszModelHelper.GetAllParamscKs(t|dkstdt|||||f|S)zTensorProtosDBInput.rzYou cannot pass reader to model_helper.TensorProtosDBInput. Use model.net.TensorProtosDBInput instead to create the op.)r8r9r)r%Zunused_blob_inrkZ batch_sizerhrirgr'r'r(TensorProtosDBInputszModelHelper.TensorProtosDBInputcCst|jdkstd|jS)Nrz6Use data_parallel_model to run model on multiple GPUs.)r8rr9r+r'r'r( GetDevicesszModelHelper.GetDevicescCs~|drt|t|sFtd|dddtj|d|tkrr|j sbtd |t d ||j |S) z?Catch-all for all other operators, mostly those without params.__zMethod z is not a registered operator.z Did you mean: [,]z#Operator {} is not known to be safezCYou are creating an op that the ModelHelper does not recognize: {}.)r^AttributeErrorrZ IsOperatorjoinrCZnearby_opnames_known_working_opsrrMrRrSr __getattr__)r%Zop_typer'r'r(rs*   zModelHelper.__getattr__cCs"ttttt|t|jtSr*)rurCr dirtyper __dict__rr+r'r'r(__dir__s  zModelHelper.__dir__cCsd|jj|jddd}|jD]}|jd|_q ||j|jdr`|jj |_ |S)zr Return param_init_net + net Net. Returns: 'core.Net' containing param_init_net and net Z _complete_netT) keep_schema/param_init_netr) rClonerr.r/ debug_infoZ AppendNetrZHasFieldr)r%Znew_netr/r'r'r(GetCompleteNets zModelHelper.GetCompleteNetcCs~g}g}t|jD]*\}}|jdr6||q||q|j|dd|dd|_|j|dd|dd|_ dS)z construct init net and train net from complete_net Inputs: net: 'core.Net' containing param_init_net and train net rz/generated_param_init_netT)rZ op_id_maskZupdate_external_listz/generated_netN) rvr.r/rrYr=rNamerr)r%rZ param_op_maskZ train_op_maskrVr/r'r'r(ConstructInitTrainNetfromNets$     z(ModelHelper.ConstructInitTrainNetfromNet)NTTFNN)N)NNN)N)NF)N)N)N)#__name__ __module__ __qualname____doc__r)propertyr&r,r5rBrErHrNrWrJ staticmethodr\rcr.rdrerjrnrprrryrmr{r|r}r~rrrrr'r'r'r(rLsH $   I        rc s<t|jd}|}t|j}t|j} ddDt|} ddDt} t} dkrri|dk r| t|} t|j z$t fddt t D} Wn"t k rtdYnXz$tfd dt t D}Wn$t k r td YnXd d }fd d}| |dD]V}| |jr||jdkr|jD]}|jdkr|tdn~|jdkrl|jj D]8}||j||j|dk r|j|j_|j|j_q||jj||jj| t|jj|ql|dk r,|j|j_|j|j_|||j |g| |j| t|j|| t|j| n t d|jt|j!| qF|j| |j| ||j||jg}D]*}|kr|"|n |"|q|j D]}||j||jq|tt|jt|fS)a Takes a model net for training and returns a net which can be used for prediction. For example, all gradient operators and input operators are removed. @param net_proto protobuf of the net you want to process (net.Proto()) @param input_blobs list/set of blob names that are the inputs of predictor @param output_blobs list/set of blob names that are outputs of predictor @param device optional device option that is assigned @param renames dictionary of blob name to a new name (optional) @param disabled_inputs optional set of blobs that are 'switched off'. This will cause branches with those blobs as inputs to be removed Z_predictcSsh|] }t|qSr'rsr`br'r'r( sz&ExtractPredictorNet..cSsh|] }t|qSr'rsrr'r'r(r sNcs.g|]&}|jr|jdkr|qS)r) intersectioninputrr`rx) input_blobsopsr'r(rbs z'ExtractPredictorNet..zNo ops with input={}cs g|]}|jr|qSr')rr1r)r output_blobsr'r(rb#szNo ops with output={}cSs:|jD].}|jdkr|jdkrtddt|qdS)NZis_testrziAn operator had is_test=0, did you try to extract a predictor from a train model (instead of test model)?z Op was: {})r2ri ExceptionrMr0)r/r2r'r'r( validate_op+s  z(ExtractPredictorNet..validate_opcsJ|dd}t|D]\}}|kr|||<q|dd=||dSr*)rvextend)Z proto_listZnew_listrxr)renamesr'r( rename_list6s   z(ExtractPredictorNet..rename_listrtZRecurrentNetworkZbackward_step_netnZstep_netzOp {} had unknown inputs: {})#rrrr.rCZexternal_inputZexternal_outputunionr3r/minranger8r<rrMmax issupersetrrr2Z ClearFieldr0rr1Z device_typeZ device_optionZ device_idr$rrrRdebug differencer=)Z net_protorrZdevicerZdisabled_inputsZ predict_netZ predict_protoZorig_external_inputsZorig_external_outputsZ known_blobsZexternal_inputsZexternal_outputsZfirst_op_with_inputZlast_op_with_outputrrr/r2Zstep_opZrenamed_input_blobsrr')rrrrr(ExtractPredictorNets                                r)NNN)Z caffe2.pythonrrrZcaffe2.python.helpers.db_inputrZcaffe2.python.modelingrZ(caffe2.python.modeling.parameter_sharingrZcaffe2.python.optimizer_contextrr Z!caffe2.python.regularizer_contextr Z future.utilsr r itertoolsr rRrobjectrrr'r'r'r(s|     1*