U dl@sddlmZmZddlmZmZddlmZmZGdddej Z Gddde Z e Z Gdd d e ZGd d d e ZGd d d e ZGdddeZGddde ZGdddeZGddde ZGddde ZGddde ZGddde ZdS))corecontext)Task TaskGroup) add_if_op add_while_opcseZdZdZdddZddZdd Zd d Zd d ZddZ ddZ dddZ ddZ ddZ fddZeddZddZZS) NetBuildera Scope-driven mechanism for building nets, loops and conditional blocks. Args: name: NetBuilder's name initial_scope: list of blobs that are available for reading/writing Example: from caffe2.python.net_builder import NetBuilder, ops with NetBuilder() as nb: c = ops.Const(5) d = ops.Const(0) with ops.loop(): ops.stop_if(ops.LE([c, ops.Const(0)])) ops.Add([c, ops.Const(-1)], [c]) with ops.If(ops.GE([c, ops.Const(3)])): ops.Add([d, ops.Const(10)], [d]) ops.Print(c, []) ops.Print(d, []) step = core.to_execution_step(nb) NFcCstjdd}|r|rtd|r0|s(|r0td|pTddd|rH|jnd|fD|_d|_d|_g|_|rv||rt |j nt |_ |r|j t dd |DO_ t |j |_ ||_ ||_ ||_dS) NFrequiredz"Cannot set both _fullname and name.Stop blobs are not used with control operators/css|]}|r|VqdSN).0nrr=/tmp/pip-unpacked-wheel-ua33x9lu/caffe2/python/net_builder.py (sz&NetBuilder.__init__..cSsg|] }t|qSr)str)rbrrr 3sz'NetBuilder.__init__..)rcurrentAssertionErrorjoinname_frozen _current_net _children_update_lexical_scopeset_lexical_scope_init_lexical_scope _stop_blob_stop_blob_required_use_control_ops)selfrZ initial_scoper"r!Z _fullnamer#parentrrr__init__!s0   zNetBuilder.__init__cCs|jrtd|jdkr|}tj|d|d|_|jd|jd|j|j dkr|j dt d|j djd|jd|jS) a? Returns the BlobReference to the stop_blob of this NetBuilder. If one is not yet available, creates one. This function assumes that the stop_blob() will be used immediatelly in the current net, so it doesn't initialize it if the current net is the first of the builder. r N stop_blob)netFZblob_outrZstop_blob_init) r#rr! current_netr BlobReferenceZNextNameConstrrinsertNetr$r(rrrr'9s zNetBuilder.stop_blobcCs2|jrtd|}t||g|gd|_dS)Nr )r#rr'opsOrr)r$blobr'rrrstop_ifMs zNetBuilder.stop_ifcCs|jrtd|jdS)Nz,This NetBuilder (%s) has been built already.)rrrr$rrr_assert_mutableTszNetBuilder._assert_mutablecCs\t|j|_|jD]D}t|tjr6|j|O_qt|tr|j r|j|jO_qdS)z Updates lexical scope based on the current list of children. Lexical scope contains names of blobs that are currently available and were introduced in the net builder N) rr rr isinstancerr.Z UsedBlobNamesrr#r$childrrrrXs    z NetBuilder._update_lexical_scopecCsd|_g|_t|j|_dSr )rrrr rr4rrr_reset_childreneszNetBuilder._reset_childrencCsb||jr2t|tjs2t|tr*|js2tdd|_|j |t|tjrV||_| |S)Nz+Expected Net or NetBuilder with control ops) r5r#r6rr.rrrrappendrr7rrraddjs   zNetBuilder.addcCs0||jdks|dk r*|t||jSr )r5rr;rr.r$rrrrr*zszNetBuilder.current_netcCs.|jD]}t|dr|qd|_d|_dS)NfreezeT)rhasattrr=rrr7rrrr=s    zNetBuilder.freezecCs||jSr )r=rr4rrrgetszNetBuilder.getcstt|j|f||jrZt|jdkrZ|j}|t||j}|sRt d|g|_| |dk rndS|j r|j dk st d|j ddS)Nrz&Expected a non-empty merge of childrenz/This NetBuilder (%s) requires a stop condition z"to be set with `stop` or `stop_if`)superr__exit__r#lenrr9 merge_netsrrr=r"r!r)r$etypeargsrZ merged_net __class__rrrAs$ zNetBuilder.__exit__csd}|D]~}d}t|tr^|js(td|}t|dkrLt|dtjsTtd|d}nt|tjsnt|}|r||q|}q|rfdd| j D}|| j dd<|S)Nz4Merging of NetBuilder supported only for control opsrzInvalid control op net buildercsg|]}|kr|qSrr)roouter_blob_namesrrrsz)NetBuilder.merge_nets..) r6rr#rr?rBrr.Z AppendNetProtoZexternal_output)Znets_or_buildersrKr(rcurnetsZexternal_outputsrrJrrCs*   zNetBuilder.merge_netscCs |jpdS)NzUn-named NetBuilderrr4rrr__str__szNetBuilder.__str__)NNFNNF)N)__name__ __module__ __qualname____doc__r&r'r3r5rr9r;r*r=r?rA staticmethodrCrP __classcell__rrrFrr s&     ,rc@seZdZdZd,ddZddZddZd d Zd d Zd-d dZ d.ddZ d/ddZ d0ddZ d1ddZ d2ddZd3ddZddZddZdd Zd!d"Zd#d$Zd4d%d&Zd5d(d)Zd6d*d+ZdS)7 Operationsz? Operations to be used in the context of a NetBuilder. NcCsB|dks|dkstd|dk r2t||Stj|dS)a Retrieves the current net, or add a new net to the builder. Args: net: If provided, add the given net to the active builder. Else, returns the current Net or creates a new one as needed. name: if provided, creates a new Net with given name and makes it the new current net of the active builder. Cannot be provided if net is provided. Nz%Cannot provide both `net` and `name`.rO)rrrr;r*)r$r(rrrrr(s zOperations.netcCs6|drttjdddkr(tdt||S)zD Adds an operator call to the currently active Net. __Fr NzNo active NetBuilder.) startswithAttributeErrorrrgetattrr()r$Zop_typerrr __getattr__s  zOperations.__getattr__c Cslddlm}t}|F|d0|}|||W5QRW5QRSQRXW5QRXdS)zs Creates a local task group which will execute as the next step of the current NetBuilder. r)tasklocalN) caffe2.pythonr]rrZClusterNoderr;)r$r]grouptgrrr task_groups    zOperations.task_groupcCs|tdS)z Stop execution of the current execution step. Example: ops.Print(a, 0) ops.stop() ops.Print(b, 0) In the example, 'b' will never be printed. T)r3r0r,r4rrrstops zOperations.stopcCst|S)ah Stop execution of the current execution step if the condition `blob` is met. Example: ops.Print(a, 0) ops.stop_if(ops.LE([x, ops.Const(0)])) ops.Print(b, 0) In the example, 'b' will only be printed if the value of scalar tensor 'x' is greater than 0. )rrr3)r$r2rrrr3s zOperations.stop_ifcCstt||dS)a Creates a NetBuilder that will execute in a loop as the next step of the current NetBuilder. If `iters` is provided, the loop will execute for `iters` iterations and then stop. `iters` can be a constant or a BlobReference. If `iters` is not provided, the loop will execute until `ops.stop` or `ops.stop_if` is called. Examples: a = ops.Const(5) with ops.loop(): ops.stop_if(ops.LE([a, ops.Const(0)])) ops.Print(a, 0) ops.Add([a, ops.Const(-1)], [a]) Above, 'a' will be printed 5 times, with values 5 to 1. with ops.loop(10) as loop: ops.LogInfo(loop.iter()) This will print the numbers from 0 to 9. x = ops.Add([ops.Const(10), ops.Const(10)]) with ops.loop(x) as loop: ops.LogInfo(loop.iter()) This will print the numbers from 0 to 19. rO)rrr;_Loopr$ZitersrrrrloopszOperations.loopcCstt||dS)a$ Creates a NetBuilder that will execute once as the next step of the current NetBuilder. After execution, a bool tensor will indicate whether the inner execution was halted with `stop` or `stop_if`. Example: a = ops.Const(True) with ops.stop_guard() as sg1: ops.stop_if(a) ops.Print(ops.Const('did not stop')) b = ops.Const(False) with ops.stop_guard() as sg2: ops.stop_if(b) ops.Print(ops.Const('did not stop')) ops.Print(sg1.has_stopped(), []) ops.Print(sg2.has_stopped(), []) In the example, 'did not stop' will be printed once, followed by True and False. )has_stopped_blobr)rrr; _StopGuardr$rhrrrr stop_guard-s zOperations.stop_guardcCstt||dS)a Creates a NetBuilder that will execute once as the next step of the current NetBuilder if the blob `cond` is True. Example: with ops.If(ops.Const(True)): ops.Print(ops.Const('Will print')) with ops.If(ops.Const(False)): ops.Print(ops.Const('Wont print')) The example will print 'Will print' once. rO)rrr;_RunIfr$ZcondrrrrIfCs z Operations.IfcCstt||dS)zT Same as If, but uses 'If' operator instead of execution step logic rO)rrr; _RunIfNetrmrrrIfNetPszOperations.IfNetcCs t|dS)z Else branch of IfNet, has to be specified immediately after IfNet. Example: with ops.IfNet(ops.LT([x, y])): ... with ops.Else(): ... rO) _RunElseNetr<rrrElseVs zOperations.ElsecCstt|dS)z9 NetBuilder for 'While' control operator rO)rrr; _RunWhileNetr<rrrWhileNetaszOperations.WhileNetcCs tttstdt|dS)zD Loop's condition, executed within WhileNet context z$Use of Condition outside of WhileNetrO)r6rrrsr_RunWhileConditionr<rrr ConditiongszOperations.ConditioncCs ttj}|tj||S)a Defines operations that will be executed once at task startup. Useful when implementing processors, that don't have access to the Task top-level structure. This setup will be run only once, even if multiple instances of the task will run in parallel. For instance-local initialization, use `task_instance_init` instead. Example: def my_processor(rec): with ops.task_init(): one = ops.Const(1) two = ops.Const(1) return Tuple( ops.Add(rec[0](), zero), ops.Add(rec[1](), two)) ) _SetupBuilderINITr( add_attributer TASK_SETUPr$setuprrr task_initos zOperations.task_initcCs ttj}|tj||S)a< Define operations to be executed once at task shutdown. Useful when implementing processors, that don't have access to the Task top-level structure. This shutdown will be run only once, after all concurrent instances of the task have already finished. For instance-local shutdown, use `task_instance_exit` instead. Example: def read_queue(queue): with ops.task_exit(): queue.close(ops.net()) return queue.read(ops.net()) )rwEXITr(ryrrzr{rrr task_exits zOperations.task_exitcCs ttj}|tj||S)aw Defines operations that will be executed once at startup of each instance of a task. This can be seen as "thread_local" initialization. It is guaranteed to run only after all `task_init` logic finishes. This setup will be run concurrently for each instance of a task. For global task initialization, use `task_init` instead. )rwrxr(ryrTASK_INSTANCE_SETUPr{rrrtask_instance_inits zOperations.task_instance_initcCs ttj}|tj||S)a( Defines operations that will be executed once at shutdown of each instance of a task. This can be seen as "thread_local" finalization. This shutdown will be run concurrently for each instance of a task. For global task shutdown, use `task_exit` instead. )rwr~r(ryrrr{rrrtask_instance_exits zOperations.task_instance_exitcCs ttj}|tj||S)a& Similar to `task_init`, but executes at TaskGroup's startup instead, before any task of the group starts executing. This will run only once on each node, before initialization of any task, so it can be used e.g. to initialize blobs shared across tasks. )rwrxr(ryr LOCAL_SETUPr{rrr local_inits zOperations.local_initcCs"ttj|}|tj||S)z Similar to `task_exit`, but executes at TaskGroup's exit instead, after all tasks of the group finished execution. This will run only once on each node. )rwr~r(ryrr)r$rr|rrr local_exits zOperations.local_exitcCst|||dS)am Define operations to be executed at every time interval from task start-up to finish. These operations are guaranteed to execute at least once after all other operations of the task are finished. Example: with ops.task_reporter(interval_ms=10000): ops.LogInfo('10s elapsed') )r(r)_ReporterBuilderr(r$ interval_msrrrr task_reporters zOperations.task_reportercCs t||dS)z Similar to task_report, but operations defined within this block will run repeatedly for as long as any of the tasks in the current TaskGroup have not finished. rO)rrrrrlocal_reporterszOperations.local_reporter)NN)NN)NN)N)N)N)N)N)N)rN)rN)rQrRrSrTr(r\rcrdr3rgrkrnrprrrtrvr}rrrrrrrrrrrrWs*            rWc@seZdZdddZddZdS)rNcCst||||_||_dSr )rr&_netr)r$rr(rrrrr&s z_ReporterBuilder.__init__cGs`|dkrJt|}||j|jr6|jtj|nt j ||jdt j ||f|dS)N)r) rto_execution_stepZRunEveryMillisrrryrZ REPORT_STEPrrZ report_steprrA)r$rDrEsteprrrrAs  z_ReporterBuilder.__exit__)NNrQrRrSr&rArrrrrs rc@s.eZdZdZdZd ddZddZdd ZdS) rwinitexitNcCst||||_dSr )rr&type)r$rrrrrr&s z_SetupBuilder.__init__cCs|jtjkrt|SdSr )rrwrxrrr/rrrr|s z_SetupBuilder.setupcCs|jtjkrt|SdSr )rrwr~rrr/rrrrs z_SetupBuilder.exit)N)rQrRrSrxr~r&r|rrrrrrws  rwc@seZdZdddZddZdS)_RunOnceNcCst||dSr )rr&r<rrrr&sz_RunOnce.__init__cGs0|dkr|jdk rttj||f|dSr )r!r0rdrrAr$rDrErrrrAsz_RunOnce.__exit__)Nrrrrrrs rc@s.eZdZd ddZddZddZdd ZdS) riNcCst||||_d|_dSNF)rr&_stopped_ranrjrrrr&s z_StopGuard.__init__cCs t|}tjd|jd|_|SNTr))r __enter__r0r,rr$rrrrrs z_StopGuard.__enter__cGs4|dkrd|_tjd|jdtj||f|dS)NTFr))rr0r,rrrArrrrrAsz_StopGuard.__exit__cCs|jstd|jS)z Return a blob that will be set to scalar bool `True` after this net builder ran, iff it was halted early. zContext not used yet.)rrrr4rrr has_stoppedsz_StopGuard.has_stopped)NN)rQrRrSr&rrArrrrrri s ric@s.eZdZd ddZddZddZdd ZdS) reNcCsXtj||dd|dk rNtd|_td|_t|tjr@|nt||_ nd|_ dS)NT)r"rHr) rr&r0r,_inc_iterr6rr+ _num_itersrfrrrr&(s  z_Loop.__init__cCs*|jdk std|jdk s$td|jS)Nz/This loop does not have a number of iterations.z2iter() must be called from inside the loop context)rrrr4rrriter3s  z _Loop.itercCs0t|}|jdk r,tt|j|jg|Sr )rrrr0r3ZGEr)r$Zbuilderrrrr:s  z_Loop.__enter__cGsD|dkr.|jdk r.||j|jg|jgtj||f|dSr )rr*ZAddrrrrA)r$rrErrrrA@sz_Loop.__exit__)NN)rQrRrSr&rrrArrrrre's rec@s2eZdZd ddZddZd ddZd dd ZdS) rlNcCspt|||s|st|dk|_|dkrDt||_td|_n(||_|dkrV|nt |t|g|_dSr) rr&r_is_elser0ZNot _else_blobr, _already_ranr1)r$ cond_blobrrrrrr&Gs     z_RunIf.__init__cCs*t|}t|jtjd|jd|Sr)rrr0r3rr,rrrrrrSs  z_RunIf.__enter__cCs.|jrtdtt||p"|j|jdS)NzElse not allowed for an Else.rrrrrrr;rlrrrmrrrElifYs  z _RunIf.ElifcCs,|jrtdtt|p |j|jdS)NzElif not allowed for an Else.rrr<rrrrr^sz _RunIf.Else)NNN)N)N)rQrRrSr&rrrrrrrrrlFs  rlc@s*eZdZdZd ddZddZddZdS) roz6 Generates a single net that uses If operator NcCs2tj||dd|std||_d|_d|_dS)NTrr#z/Conditional blob is not specified for an If net)rr&r _cond_blob _then_net _else_net)r$rrrrrr&hs  z_RunIfNet.__init__cCs t||Sr )rr;r7rrrr;osz _RunIfNet.addcGs|dkrn|j}|t||j|_|js8td|_t|jd}t ||j |j|j|j ||_ |g|_tj ||f|dS)NZempty_then_netz/if_net)rr9rrCrrrr.rrrrrrA)r$rrEZ _then_netsZif_netrrrrArs"  z_RunIfNet.__exit__)N)rQrRrSrTr&r;rArrrrrods roc@s"eZdZdZdddZddZdS)rqz+ Else branch for _RunIfNet builder NcCsVtj||ddtjdd}|r>t|jdkr>t|jdtsFtd|jd|_dS)NTrFr rzInvalid use of Else builder) rr&rrBrr6ror _if_builderr$rr%rrrr&s z_RunElseNet.__init__cGs|dkrp|j}|t||j|j_|jjrpt|j d}t ||jj |j|jj |jj||j_ |g|j_tj||f|dS)Nz /if_else_net)rr9rrCrrrrr.rrrrrrA)r$rrEZ _else_netsZ if_else_netrrrrAs& z_RunElseNet.__exit__)NrQrRrSrTr&rArrrrrqs rqc@s"eZdZdZdddZddZdS)rsz9 Generates a single net that uses While operator NcCstj||ddd|_dS)NTr)rr& _cond_builderr<rrrr&sz_RunWhileNet.__init__cGs|dkr|jstd|jj}|jj}|j}|t||j}|sPt d}t |j d}t |||j||||_ |g|_tj||f|dS)Nz/Condition builder must be specified in While opZempty_loop_body_netz /while_net)rrr _cond_netrr9rrCrrr.rrrrA)r$rrErrZ loop_bodyZ loop_body_netZ while_netrrrrAs,  z_RunWhileNet.__exit__)Nrrrrrrss rsc@s"eZdZdZdddZddZdS)ruz Computes loop's condition, used in the context of WhileNet. Last operator must have a single scalar boolean output that will be used as a condition value, no other blobs created in the condition net are visible outside of it NcCsltj||ddtjdd}|r*t|ts2td|jr@tdt|jdksVtd||_d|_ d|_ dS) NTrFr z%Invalid use of loop condition builderz*Multiple loop condition builders specifiedrz=Condition definition must be specified before the loop's body) rr&rr6rsrrrBrrrrrrrr&s z_RunWhileCondition.__init__cGs|dkr|j}|t||j|_|js4tdt|jj dksPtd|jj d}t|j dksvtdt j |j ddd|_ |j|_|jg|_tj||f|dS)Nz Invalid loop condition specifiedrzInvalid condition netrrH)rr()rr9rrCrrrrBrLopoutputrr+rrrA)r$rrEZcondition_bodyZlast_oprrrrAs z_RunWhileCondition.__exit__)Nrrrrrrus ruN)r_rrZcaffe2.python.taskrrZcaffe2.python.control_ops_utilrrZManagedrobjectrWr0rrwrrirerlrorqrsrurrrrs$B !