Skip to content

Commit d3cfe97

Browse files
committed
Start Quickstart docs
1 parent 709f226 commit d3cfe97

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# ABSTRACT: Start here for an overview
2+
# PODNAME: Quickstart
3+
=pod
4+
5+
=head1 DESCRIPTION
6+
7+
This provides a tour of C<libtensorflow> to help get started with using the
8+
library.
9+
10+
=head1 CONVENTIONS
11+
12+
The library uses UpperCamelCase naming convention for method names in order to
13+
match the underlying C library (for compatibility with future API changes) and
14+
to make translating code from C easier as this is a low-level API.
15+
16+
As such, constructors for objects that correspond to C<libtensorflow> data
17+
structures are typically called C<New>. For example, a new
18+
L<AI::TensorFlow::Libtensorflow::Status> object can be created as follows
19+
20+
use AI::TensorFlow::Libtensorflow::Status;
21+
my $status = AI::TensorFlow::Libtensorflow::Status->New;
22+
23+
ok defined $status, 'Created new Status';
24+
25+
These C<libtensorflow> data structures use L<destructors|perlobj/Destructors> where necessary.
26+
27+
=head1 TUTORIALS
28+
29+
=begin :list
30+
31+
* L<InferenceUsingTFHubMobileNetV2Model|AI::TensorFlow::Libtensorflow::Manual::InferenceUsingTFHubMobileNetV2Model>
32+
33+
=end :list
34+
35+
=head1 OBJECT TYPES
36+
37+
=begin :list
38+
39+
= L<AI::TensorFlow::Libtensorflow::Status>
40+
Used for error-handling. Many methods take this as the final argument which is
41+
then checked after the method call to ensure that it completed successfully.
42+
43+
= L<AI::TensorFlow::Libtensorflow::Session>
44+
45+
= L<AI::TensorFlow::Libtensorflow::SessionOptions>
46+
47+
= L<AI::TensorFlow::Libtensorflow::Graph>
48+
49+
= L<AI::TensorFlow::Libtensorflow::OperationDescription>
50+
51+
= L<AI::TensorFlow::Libtensorflow::Operation>
52+
53+
= L<AI::TensorFlow::Libtensorflow::Tensor>
54+
55+
=end :list
56+
57+
=cut

Diff for: xt/author/pod-snippets.t

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ my @modules = qw/
1313
AI::TensorFlow::Libtensorflow::DataType
1414
AI::TensorFlow::Libtensorflow::Graph
1515
AI::TensorFlow::Libtensorflow::Tensor
16+
17+
AI::TensorFlow::Libtensorflow::Manual::Quickstart
1618
/;
1719

1820
plan tests => 0 + @modules;

0 commit comments

Comments
 (0)